imp_sockets.h

Go to the documentation of this file.

#ifndef SOCKETS_IMPLEMENTATION_ONLY_GROUP
#define SOCKETS_IMPLEMENTATION_ONLY_GROUP

/*****************************************************************************\
*                                                                             *
*  Name   : sockets implementation only support                               *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Commonly required headers and macros for code files only.                *
*                                                                             *
*******************************************************************************
* Copyright (c) 1994-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "sockets_dll.h"

#include <basis/istring.h>
#include <basis/log_base.h>
#include <textual/tokenizer.h>


// wraps a macro in standard stuff.

#define WRAPUP(retval, to_wrap) { FUNCTION(func); to_wrap; return retval; }


// logs a complaint about a response being garbled.

void SOCKETS_CLASS_STYLE sockets_complain_garbage(const istring &f);
#define COMPLAIN_GARBAGE(retval) \
  { WRAPUP(retval, sockets_complain_garbage(function_name)); }


// submits a qualm regarding the health of an object "what".

void SOCKETS_CLASS_STYLE sockets_complain_dead(const istring &f,
    const istring &what);
#define COMPLAIN_DEAD(what, retval) \
  { WRAPUP(retval, sockets_complain_dead(function_name, what)); }


// complains when a cefloon request fails for a command "what".

void SOCKETS_CLASS_STYLE sockets_complain_reject(const istring &f,
    const istring &what);
#define COMPLAIN_REJECT(what, retval) \
  { WRAPUP(retval, sockets_complain_reject(function_name, what)); }


// these macros are parser bits used in tokenizing and detokenizing.

const char SOCKETS_CLASS_STYLE *TOKEN_SEPARATOR();
const char SOCKETS_CLASS_STYLE *TOKEN_ASSIGN();

// begins operation of a tokenizer for loading.  LOADER_EXIT must be called
// after finishing with the tokenizer.
#define LOADER_ENTRY \
  tokenizer addr_parser; \
  addr_parser.parse(info)

#define LOADER_EXIT 
  // currently no implementation.

// locates a variable in the tokenizer.
#define FIND(name, value) istring value = addr_parser.find(name)

// locates a variable like FIND, but returns if it couldn't find it.
#define GRAB(name, value) FIND(name, value); if (!value) return false

// begins operation of a tokenizer for storing.  remember to call STORER_EXIT
// when finished.
#define STORER_ENTRY \
  tokenizer addr_parser

#define STORER_EXIT 
  // currently no implementation.

// adds a new entry into the tokenizer.
#define ADD(name, value) addr_parser.table().add(name, value)

// returns the accumulated tokens in the storing tokenizer.
#define DUMP_EXIT istring to_return = addr_parser.text_form(); \
  STORER_EXIT; \
  return to_return

#endif

---