src/ESIParser.h

   1 /*
   2  * $Id$
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  */
  32 #ifndef SQUID_ESIPARSER_H
  33 #define SQUID_ESIPARSER_H
  34
  35 /* for size_t */
  36 #include "config.h"
  37
  38 class ESIParserClient
  39 {
  40 public:
  41     virtual void start(const char *el, const char **attr, size_t attrCount) = 0;
  42     virtual void end(const char *el) = 0;
  43     virtual void parserDefault (const char *s, int len) =0;
  44     virtual void parserComment (const char *s) = 0;
  45     virtual ~ESIParserClient() {};
  46 };
  47
  48
  49 /* for RefCountable */
  50 #include "RefCount.h"
  51
  52 class ESIParser : public RefCountable
  53 {
  54 public:
  55     typedef RefCount<ESIParser> Pointer;
  56
  57     static void registerParser(const char *name, Pointer (*new_func)(ESIParserClient *aClient));
  58     static Pointer NewParser(ESIParserClient *aClient);
  59     static char *Type;
  60
  61     /**
  62      \retval true      on success
  63      \retval false     on what?
  64      */
  65     virtual bool parse(char const *dataToParse, size_t const lengthOfData, bool const endOfStream) = 0;
  66
  67     virtual long int lineNumber() const =0;
  68     virtual char const * errorString() const =0;
  69
  70 protected:
  71     ESIParser() {};
  72
  73     class Register;
  74
  75 private:
  76     static Register *Parser;
  77     static Register *Parsers;
  78
  79 public:
  80 };
  81
  82 class ESIParser::Register
  83 {
  84
  85 public:
  86     Register(const char *_name, ESIParser::Pointer (*_newParser)(ESIParserClient *aClient)) : name(_name), newParser(_newParser) {
  87         this->next = ESIParser::Parsers;
  88         ESIParser::Parsers = this;
  89     }
  90
  91     const char *name;
  92     ESIParser::Pointer (*newParser)(ESIParserClient *aClient);
  93     Register * next;
  94 };
  95
  96 #define RegisterESIParser(name, ThisClass) \
  97     ESIParser::Register ThisClass::thisParser(name, &NewParser); \
  98     ESIParser::Pointer ThisClass::NewParser(ESIParserClient *aClient) \
  99     { \
 100         return new ThisClass (aClient); \
 101     }
 102
 103 #define ESI_PARSER_TYPE \
 104     static ESIParser::Pointer NewParser(ESIParserClient *aClient); \
 105     static ESIParser::Register thisParser
 106
 107
 108 #endif /* SQUID_ESIPARSER_H */