[thirdparty/squid.git] / src / ESISequence.h

/*
 * $Id$
 *
 * DEBUG: section 86    ESI processing
 * AUTHOR: Robert Collins
 *
 * SQUID Web Proxy Cache          http://www.squid-cache.org/
 * ----------------------------------------------------------
 *
 *  Squid is the result of efforts by numerous individuals from
 *  the Internet community; see the CONTRIBUTORS file for full
 *  details.   Many organizations have provided support for Squid's
 *  development; see the SPONSORS file for full details.  Squid is
 *  Copyrighted (C) 2001 by the Regents of the University of
 *  California; see the COPYRIGHT file for full details.  Squid
 *  incorporates software developed and/or copyrighted by other
 *  sources; see the CREDITS file for full details.
 *
 *  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 program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
 *
 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
 */

#ifndef SQUID_ESISEQUENCE_H
#define SQUID_ESISEQUENCE_H

#include "squid.h"
#include "ESIElement.h"
#include "ElementList.h"

/* esiSequence */

class esiSequence : public ESIElement
{

public:
    MEMPROXY_CLASS(esiSequence);

    esiSequence(esiTreeParentPtr, bool = false);
    ~esiSequence();

    void render(ESISegment::Pointer);
    bool addElement (ESIElement::Pointer);
    esiProcessResult_t process (int dovars);
    void provideData (ESISegment::Pointer, ESIElement*);
    bool mayFail () const;
    void wontFail();
    void fail(ESIElement *, char const *anError = NULL);
    void makeCachableElements(esiSequence const &old);
    Pointer makeCacheable() const;
    void makeUsableElements(esiSequence const &old, ESIVarState &);
    Pointer makeUsable(esiTreeParentPtr, ESIVarState &) const;

    ElementList elements; /* unprocessed or rendered nodes */
    size_t processedcount;

    struct {
        int dovars:1; /* for esiVar */
    } flags;
    void finish();

protected:
    esiSequence(esiSequence const &);
    esiTreeParentPtr parent;

private:
    int elementIndex (ESIElement::Pointer anElement) const;
    bool mayFail_;
    bool failed;
    esiProcessResult_t processOne(int, size_t);
    bool const provideIncrementalData;
    bool processing;
    esiProcessResult_t processingResult;
    size_t nextElementToProcess_;
    size_t nextElementToProcess() const;
    void nextElementToProcess(size_t const &);
    bool finishedProcessing() const;
    void processStep(int dovars);
};

MEMPROXY_CLASS_INLINE(esiSequence)          /**DOCS_NOSEMI*/

#endif /* SQUID_ESISEQUENCE_H */
Commit	Line	Data
43ae1d95	1	/*
262a0e14	2	* $Id$
43ae1d95	3	*
	4	* DEBUG: section 86 ESI processing
	5	* AUTHOR: Robert Collins
	6	*
	7	* SQUID Web Proxy Cache http://www.squid-cache.org/
	8	* ----------------------------------------------------------
	9	*
	10	* Squid is the result of efforts by numerous individuals from
	11	* the Internet community; see the CONTRIBUTORS file for full
	12	* details. Many organizations have provided support for Squid's
	13	* development; see the SPONSORS file for full details. Squid is
	14	* Copyrighted (C) 2001 by the Regents of the University of
	15	* California; see the COPYRIGHT file for full details. Squid
	16	* incorporates software developed and/or copyrighted by other
	17	* sources; see the CREDITS file for full details.
	18	*
	19	* This program is free software; you can redistribute it and/or modify
	20	* it under the terms of the GNU General Public License as published by
	21	* the Free Software Foundation; either version 2 of the License, or
	22	* (at your option) any later version.
26ac0430	23	*
43ae1d95	24	* This program is distributed in the hope that it will be useful,
	25	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	26	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	27	* GNU General Public License for more details.
26ac0430	28	*
43ae1d95	29	* You should have received a copy of the GNU General Public License
	30	* along with this program; if not, write to the Free Software
	31	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
	32	*
	33	* Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
	34	*/
	35
	36	#ifndef SQUID_ESISEQUENCE_H
	37	#define SQUID_ESISEQUENCE_H
	38
	39	#include "squid.h"
	40	#include "ESIElement.h"
	41	#include "ElementList.h"
	42
	43	/* esiSequence */
	44
	45	class esiSequence : public ESIElement
	46	{
	47
	48	public:
b001e822	49	MEMPROXY_CLASS(esiSequence);
43ae1d95	50
	51	esiSequence(esiTreeParentPtr, bool = false);
	52	~esiSequence();
	53
	54	void render(ESISegment::Pointer);
	55	bool addElement (ESIElement::Pointer);
	56	esiProcessResult_t process (int dovars);
	57	void provideData (ESISegment::Pointer, ESIElement*);
	58	bool mayFail () const;
	59	void wontFail();
924f73bc	60	void fail(ESIElement , char const anError = NULL);
43ae1d95	61	void makeCachableElements(esiSequence const &old);
43ae1d95	62	Pointer makeCacheable() const;
924f73bc	63	void makeUsableElements(esiSequence const &old, ESIVarState &);
924f73bc	64	Pointer makeUsable(esiTreeParentPtr, ESIVarState &) const;
43ae1d95	65
	66	ElementList elements; /* unprocessed or rendered nodes */
	67	size_t processedcount;
	68
26ac0430	69	struct {
3d0ac046 HN	70	int dovars:1; /* for esiVar */
3d0ac046 HN	71	} flags;
43ae1d95	72	void finish();
	73
	74	protected:
	75	esiSequence(esiSequence const &);
	76	esiTreeParentPtr parent;
	77
	78	private:
43ae1d95	79	int elementIndex (ESIElement::Pointer anElement) const;
	80	bool mayFail_;
	81	bool failed;
	82	esiProcessResult_t processOne(int, size_t);
	83	bool const provideIncrementalData;
	84	bool processing;
	85	esiProcessResult_t processingResult;
	86	size_t nextElementToProcess_;
	87	size_t nextElementToProcess() const;
	88	void nextElementToProcess(size_t const &);
	89	bool finishedProcessing() const;
	90	void processStep(int dovars);
	91	};
	92
63be0a78	93	MEMPROXY_CLASS_INLINE(esiSequence) /*DOCS_NOSEMI/
b001e822	94
43ae1d95	95	#endif /* SQUID_ESISEQUENCE_H */