]>
Commit | Line | Data |
---|---|---|
43ae1d95 | 1 | /* |
924f73bc | 2 | * $Id: ESIElement.h,v 1.2 2003/07/14 14:15:56 robertc Exp $ |
43ae1d95 | 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 | ||
33 | #ifndef SQUID_ESIELEMENT_H | |
34 | #define SQUID_ESIELEMENT_H | |
35 | ||
36 | #include "RefCount.h" | |
37 | #include "ESISegment.h" | |
38 | ||
39 | typedef enum { | |
40 | ESI_PROCESS_COMPLETE = 0, | |
41 | ESI_PROCESS_PENDING_WONTFAIL = 1, | |
42 | ESI_PROCESS_PENDING_MAYFAIL = 2, | |
43 | ESI_PROCESS_FAILED = 3 | |
44 | } esiProcessResult_t; | |
45 | ||
46 | class ESIElement; | |
47 | ||
48 | struct esiTreeParent : public RefCountable | |
49 | { | |
50 | virtual void provideData (ESISegment::Pointer data, ESIElement * source) | |
51 | { | |
52 | /* make abstract when all functionality complete */ | |
53 | assert (0); | |
54 | } | |
55 | ||
924f73bc | 56 | virtual void fail(ESIElement * source, char const *reason = NULL) {} |
43ae1d95 | 57 | |
58 | virtual ~esiTreeParent(){}} | |
59 | ||
60 | ; | |
61 | ||
62 | typedef RefCount<esiTreeParent> esiTreeParentPtr; | |
63 | ||
924f73bc | 64 | class ESIVarState; |
43ae1d95 | 65 | |
66 | struct ESIElement : public esiTreeParent | |
67 | { | |
68 | typedef RefCount<ESIElement> Pointer; | |
69 | ||
70 | /* the types we have */ | |
71 | enum ESIElementType_t { | |
72 | ESI_ELEMENT_NONE, | |
73 | ESI_ELEMENT_INCLUDE, | |
74 | ESI_ELEMENT_COMMENT, | |
75 | ESI_ELEMENT_REMOVE, | |
76 | ESI_ELEMENT_TRY, | |
77 | ESI_ELEMENT_ATTEMPT, | |
78 | ESI_ELEMENT_EXCEPT, | |
79 | ESI_ELEMENT_VARS, | |
80 | ESI_ELEMENT_CHOOSE, | |
81 | ESI_ELEMENT_WHEN, | |
924f73bc | 82 | ESI_ELEMENT_OTHERWISE, |
83 | ESI_ELEMENT_ASSIGN | |
43ae1d95 | 84 | }; |
85 | static ESIElementType_t IdentifyElement (const char *); | |
86 | virtual bool addElement(ESIElement::Pointer) | |
87 | { | |
88 | /* Don't accept children */ | |
89 | debug (86,5)("ESIElement::addElement: Failed for %p\n",this); | |
90 | return false; | |
91 | } | |
92 | ||
93 | virtual void render (ESISegment::Pointer) = 0; | |
94 | /* process this element */ | |
95 | virtual esiProcessResult_t process (int dovars) | |
96 | { | |
97 | debug (86,5) ("esiProcessComplete: Processed %p\n",this); | |
98 | return ESI_PROCESS_COMPLETE; | |
99 | } | |
100 | ||
101 | virtual void deleteSelf() const = 0; | |
102 | ||
103 | virtual bool mayFail() const | |
104 | { | |
105 | return true; | |
106 | } | |
107 | ||
108 | virtual Pointer makeCacheable() const = 0; | |
924f73bc | 109 | virtual Pointer makeUsable(esiTreeParentPtr, ESIVarState &) const = 0; |
43ae1d95 | 110 | |
111 | /* The top level no longer needs this element */ | |
112 | virtual void finish() = 0; | |
113 | }; | |
114 | ||
115 | #endif /* SQUID_ESIELEMENT_H */ |