File: Parser.hh

package info (click to toggle)
3dwm 0.3.1-8
  • links: PTS
  • area: main
  • in suites: woody
  • size: 3,368 kB
  • ctags: 2,547
  • sloc: cpp: 11,981; sh: 7,850; ansic: 851; makefile: 287; yacc: 135; lex: 92
file content (122 lines) | stat: -rw-r--r-- 3,626 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/* ------------------------------------------------------------------------
 * $Id: Parser.hh,v 1.1 2001/08/16 11:32:21 elm Exp $
 *
 * This file is part of 3Dwm: The Three-Dimensional User Environment.
 *
 * 3Dwm: The Three-Dimensional User Environment:
 *	<http://www.3dwm.org>
 *
 * Chalmers Medialab
 * 	<http://www.medialab.chalmers.se>
 * 
 * This C++ SAX implementation (Simple API for XML) is derived from
 * David Megginson's original Java SAX that can be found on 
 * http://www.megginson.com/SAX/.
 * ------------------------------------------------------------------------
 * File created 2001-08-14 by Niklas Elmqvist.
 *
 * Copyright (c) 2001 Niklas Elmqvist <elm@3dwm.org>.
 * ------------------------------------------------------------------------
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 * ------------------------------------------------------------------------ 
 */

#ifndef _SAXParser_hh_
#define _SAXParser_hh_

// -- System Includes
#include <string>

namespace SAX {

    // -- Forward Declarations
    class DTDHandler;
    class ErrorHandler;
    class EntityResolver;
    class DocumentHandler;
    class InputSource;

    // -- Class Declarations

    /**
     * Basic interface for SAX (Simple API for XML) parsers.
     **/
    class Parser {
    public:
	
	/**
	 * Constructor.
	 **/
	Parser() { }

	/**
	 * Destructor.
	 **/
	virtual ~Parser() { }

	/**
	 * Allow an application to register a custom entity resolver.
	 *
	 * @param resolver pointer to object for resolving entities.
	 **/
	virtual void setEntityResolver(EntityResolver *resolver) = 0;

	/**
	 * Allow an application to register a DTD event handler. 
	 *
	 * @param handler pointer DTD handler.
	 **/
	virtual void setDTDHandler(DTDHandler *handler) = 0;

	/**
	 * Allow an application to register a document event handler. 
	 *
	 * @param handler pointer to document handler.
	 **/ 
	virtual void setDocumentHandler(DocumentHandler *handler) = 0;
	
	/**
	 * Allow an application to register an error event handler. 
	 *
	 * @param pointer to error handler.
	 **/
	virtual void setErrorHandler(ErrorHandler *handler) = 0; 

	/**
	 * Parse an XML document. Applications may not invoke this
	 * method while a parse is in progress (they should create a
	 * new Parser instead for each additional XML document). Once
	 * a parse is complete, an application may reuse the same
	 * Parser object, possibly with a different input source.
	 *
	 * @param input source for the top-level of the XML document. 
	 **/
	virtual void parse(InputSource &source) = 0;
	
	/**
	 * Parse an XML document from a system identifier (URI). This
	 * method is a shortcut for the common case of reading a
	 * document from a system identifier.
	 * 
	 * @note Only file names are supported in this implementation!
	 * @param systemId system identifier (URI).
	 **/ 
	virtual void parse(const std::string &systemId) = 0;
    };

};

#endif /* Parser.hh */