xref: /AOO41X/main/xmloff/inc/XMLEventImportHelper.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 _XMLOFF_EVENTIMPORTHELPER_HXX
29*cdf0e10cSrcweir #define _XMLOFF_EVENTIMPORTHELPER_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <com/sun/star/uno/Reference.hxx>
32*cdf0e10cSrcweir #include <xmloff/xmlevent.hxx>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir #include <map>
35*cdf0e10cSrcweir #include <list>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir namespace com { namespace sun { namespace star {
39*cdf0e10cSrcweir 	namespace xml { namespace sax {	class XAttributeList; } }
40*cdf0e10cSrcweir } } }
41*cdf0e10cSrcweir namespace rtl {	class OUString; }
42*cdf0e10cSrcweir class XMLEventContextFactory;
43*cdf0e10cSrcweir class XMLEventsImportContext;
44*cdf0e10cSrcweir struct XMLEventNameTranslation;
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir typedef ::std::map< ::rtl::OUString, XMLEventContextFactory* > FactoryMap;
47*cdf0e10cSrcweir typedef ::std::map< XMLEventName, ::rtl::OUString > NameMap;
48*cdf0e10cSrcweir typedef ::std::list< NameMap* > NameMapList;
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir /**
52*cdf0e10cSrcweir  * Helps the XMLEventsImportContext.
53*cdf0e10cSrcweir  *
54*cdf0e10cSrcweir  * This class stores
55*cdf0e10cSrcweir  * a) the translation from XML event names to API event names, and
56*cdf0e10cSrcweir  * b) a mapping from script language names to XMLEventContextFactory objects
57*cdf0e10cSrcweir  *    (that handle particular languages).
58*cdf0e10cSrcweir  *
59*cdf0e10cSrcweir  * Event name translation tables may be added, i.e. they will be joined
60*cdf0e10cSrcweir  * together. If different translations are needed (i.e., if the same XML name
61*cdf0e10cSrcweir  * needs to be translated to different API names in different contexts), then
62*cdf0e10cSrcweir  * translation tables may be saved on a translation table stack.
63*cdf0e10cSrcweir  */
64*cdf0e10cSrcweir class XMLEventImportHelper
65*cdf0e10cSrcweir {
66*cdf0e10cSrcweir 	/// map of XMLEventContextFactory objects
67*cdf0e10cSrcweir 	FactoryMap aFactoryMap;
68*cdf0e10cSrcweir 
69*cdf0e10cSrcweir 	/// map from XML to API names
70*cdf0e10cSrcweir 	NameMap* pEventNameMap;
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir 	/// stack of previous aEventNameMap
73*cdf0e10cSrcweir 	NameMapList aEventNameMapList;
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir public:
76*cdf0e10cSrcweir 	XMLEventImportHelper();
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir 	~XMLEventImportHelper();
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir 	/// register a handler for a particular language type
81*cdf0e10cSrcweir 	void RegisterFactory( const ::rtl::OUString& rLanguage,
82*cdf0e10cSrcweir 						  XMLEventContextFactory* aFactory );
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir 	/// add event name translation to the internal table
85*cdf0e10cSrcweir 	void AddTranslationTable( const XMLEventNameTranslation* pTransTable );
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir 	/// save the old translation table on a stack and install an empty table
88*cdf0e10cSrcweir 	void PushTranslationTable();
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir 	/// recover the top-most previously saved translation table
91*cdf0e10cSrcweir 	void PopTranslationTable();
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir 	/// create an appropriate import context for a particular event
94*cdf0e10cSrcweir 	SvXMLImportContext* CreateContext(
95*cdf0e10cSrcweir 		SvXMLImport& rImport,
96*cdf0e10cSrcweir 		sal_uInt16 nPrefix,
97*cdf0e10cSrcweir 		const ::rtl::OUString& rLocalName,
98*cdf0e10cSrcweir 		const ::com::sun::star::uno::Reference<
99*cdf0e10cSrcweir 			::com::sun::star::xml::sax::XAttributeList> & xAttrList,
100*cdf0e10cSrcweir 		XMLEventsImportContext* rEvents,
101*cdf0e10cSrcweir 		const ::rtl::OUString& rXmlEventName,
102*cdf0e10cSrcweir 		const ::rtl::OUString& rLanguage);
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir };
105*cdf0e10cSrcweir 
106*cdf0e10cSrcweir #endif
107