xref: /AOO41X/main/unoxml/source/dom/documentbuilder.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef DOM_DOCUMENTBUILDER_HXX
29*cdf0e10cSrcweir #define DOM_DOCUMENTBUILDER_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <sal/types.h>
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #include <cppuhelper/implbase2.hxx>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #include <com/sun/star/uno/Reference.h>
36*cdf0e10cSrcweir #include <com/sun/star/uno/Sequence.h>
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir #include <com/sun/star/uno/XInterface.hpp>
39*cdf0e10cSrcweir #include <com/sun/star/xml/dom/XDocumentBuilder.hpp>
40*cdf0e10cSrcweir #include <com/sun/star/xml/dom/XDocument.hpp>
41*cdf0e10cSrcweir #include <com/sun/star/xml/dom/XDOMImplementation.hpp>
42*cdf0e10cSrcweir #include <com/sun/star/xml/sax/XEntityResolver.hpp>
43*cdf0e10cSrcweir #include <com/sun/star/xml/sax/XErrorHandler.hpp>
44*cdf0e10cSrcweir #include <com/sun/star/xml/sax/SAXParseException.hpp>
45*cdf0e10cSrcweir #include <com/sun/star/io/XInputStream.hpp>
46*cdf0e10cSrcweir #include <com/sun/star/io/IOException.hpp>
47*cdf0e10cSrcweir #include <com/sun/star/lang/XServiceInfo.hpp>
48*cdf0e10cSrcweir #include <com/sun/star/lang/XMultiServiceFactory.hpp>
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir using ::rtl::OUString;
52*cdf0e10cSrcweir using namespace com::sun::star::uno;
53*cdf0e10cSrcweir using namespace com::sun::star::lang;
54*cdf0e10cSrcweir using namespace com::sun::star::xml::dom;
55*cdf0e10cSrcweir using namespace com::sun::star::xml::sax;
56*cdf0e10cSrcweir using namespace com::sun::star::io;
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir namespace DOM
59*cdf0e10cSrcweir {
60*cdf0e10cSrcweir     typedef ::cppu::WeakImplHelper2
61*cdf0e10cSrcweir         < XDocumentBuilder
62*cdf0e10cSrcweir         , ::com::sun::star::lang::XServiceInfo
63*cdf0e10cSrcweir         > CDocumentBuilder_Base;
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir     class CDocumentBuilder
66*cdf0e10cSrcweir         : public CDocumentBuilder_Base
67*cdf0e10cSrcweir     {
68*cdf0e10cSrcweir     private:
69*cdf0e10cSrcweir         ::osl::Mutex m_Mutex;
70*cdf0e10cSrcweir         Reference< ::com::sun::star::lang::XMultiServiceFactory > const
71*cdf0e10cSrcweir             m_xFactory;
72*cdf0e10cSrcweir         Reference< XEntityResolver > m_xEntityResolver;
73*cdf0e10cSrcweir         Reference< XErrorHandler > m_xErrorHandler;
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir     public:
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir         // ctor
78*cdf0e10cSrcweir         CDocumentBuilder(
79*cdf0e10cSrcweir             Reference< ::com::sun::star::lang::XMultiServiceFactory > const&
80*cdf0e10cSrcweir                 xFactory);
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir         // call for factory
83*cdf0e10cSrcweir         static Reference< XInterface > getInstance(
84*cdf0e10cSrcweir             Reference< ::com::sun::star::lang::XMultiServiceFactory > const&
85*cdf0e10cSrcweir                 xFactory);
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir         // static helpers for service info and component management
88*cdf0e10cSrcweir         static const char* aImplementationName;
89*cdf0e10cSrcweir 	    static const char* aSupportedServiceNames[];
90*cdf0e10cSrcweir         static OUString _getImplementationName();
91*cdf0e10cSrcweir         static Sequence< OUString > _getSupportedServiceNames();
92*cdf0e10cSrcweir         static Reference< XInterface > _getInstance(
93*cdf0e10cSrcweir             Reference< ::com::sun::star::lang::XMultiServiceFactory > const&
94*cdf0e10cSrcweir                 rSMgr);
95*cdf0e10cSrcweir 
96*cdf0e10cSrcweir         // XServiceInfo
97*cdf0e10cSrcweir         virtual OUString SAL_CALL getImplementationName()
98*cdf0e10cSrcweir             throw (RuntimeException);
99*cdf0e10cSrcweir         virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName)
100*cdf0e10cSrcweir             throw (RuntimeException);
101*cdf0e10cSrcweir         virtual Sequence< OUString > SAL_CALL getSupportedServiceNames ()
102*cdf0e10cSrcweir             throw (RuntimeException);
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir         /**
105*cdf0e10cSrcweir         Obtain an instance of a DOMImplementation object.
106*cdf0e10cSrcweir         */
107*cdf0e10cSrcweir         virtual Reference< XDOMImplementation > SAL_CALL getDOMImplementation()
108*cdf0e10cSrcweir             throw (RuntimeException);
109*cdf0e10cSrcweir 
110*cdf0e10cSrcweir         /**
111*cdf0e10cSrcweir         Indicates whether or not this parser is configured to understand
112*cdf0e10cSrcweir         namespaces.
113*cdf0e10cSrcweir         */
114*cdf0e10cSrcweir         virtual sal_Bool SAL_CALL isNamespaceAware()
115*cdf0e10cSrcweir             throw (RuntimeException);
116*cdf0e10cSrcweir 
117*cdf0e10cSrcweir         /**
118*cdf0e10cSrcweir         Indicates whether or not this parser is configured to validate XML
119*cdf0e10cSrcweir         documents.
120*cdf0e10cSrcweir         */
121*cdf0e10cSrcweir         virtual sal_Bool SAL_CALL isValidating()
122*cdf0e10cSrcweir             throw (RuntimeException);
123*cdf0e10cSrcweir 
124*cdf0e10cSrcweir         /**
125*cdf0e10cSrcweir         Obtain a new instance of a DOM Document object to build a DOM tree
126*cdf0e10cSrcweir         with.
127*cdf0e10cSrcweir         */
128*cdf0e10cSrcweir         virtual Reference< XDocument > SAL_CALL newDocument()
129*cdf0e10cSrcweir             throw (RuntimeException);
130*cdf0e10cSrcweir 
131*cdf0e10cSrcweir         /**
132*cdf0e10cSrcweir         Parse the content of the given InputStream as an XML document and
133*cdf0e10cSrcweir         return a new DOM Document object.
134*cdf0e10cSrcweir         */
135*cdf0e10cSrcweir         virtual Reference< XDocument > SAL_CALL parse(const Reference< XInputStream >& is)
136*cdf0e10cSrcweir             throw (RuntimeException, SAXParseException, IOException);
137*cdf0e10cSrcweir 
138*cdf0e10cSrcweir         /**
139*cdf0e10cSrcweir         Parse the content of the given URI as an XML document and return
140*cdf0e10cSrcweir         a new DOM Document object.
141*cdf0e10cSrcweir         */
142*cdf0e10cSrcweir         virtual Reference< XDocument > SAL_CALL parseURI(const OUString& uri)
143*cdf0e10cSrcweir 			throw (RuntimeException, SAXParseException, IOException);
144*cdf0e10cSrcweir 
145*cdf0e10cSrcweir         /**
146*cdf0e10cSrcweir         Specify the EntityResolver to be used to resolve entities present
147*cdf0e10cSrcweir         in the XML document to be parsed.
148*cdf0e10cSrcweir         */
149*cdf0e10cSrcweir         virtual void SAL_CALL setEntityResolver(const Reference< XEntityResolver >& er)
150*cdf0e10cSrcweir 			throw (RuntimeException);
151*cdf0e10cSrcweir 
152*cdf0e10cSrcweir         virtual Reference< XEntityResolver > SAL_CALL getEntityResolver()
153*cdf0e10cSrcweir 			throw (RuntimeException);
154*cdf0e10cSrcweir 
155*cdf0e10cSrcweir 
156*cdf0e10cSrcweir         /**
157*cdf0e10cSrcweir         Specify the ErrorHandler to be used to report errors present in
158*cdf0e10cSrcweir         the XML document to be parsed.
159*cdf0e10cSrcweir         */
160*cdf0e10cSrcweir         virtual void SAL_CALL setErrorHandler(const Reference< XErrorHandler >& eh)
161*cdf0e10cSrcweir 			throw (RuntimeException);
162*cdf0e10cSrcweir     };
163*cdf0e10cSrcweir }
164*cdf0e10cSrcweir 
165*cdf0e10cSrcweir #endif
166