l10ntools/inc/xmlparse.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_L10NTOOLS_INC_XMLPARSE_HXX
  21 #define INCLUDED_L10NTOOLS_INC_XMLPARSE_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <cstddef>
  26 #include <memory>
  27 #include <vector>
  28
  29 #include <signal.h>
  30
  31 #include <libxml/xmlexports.h>
  32 #include <expat.h>
  33
  34 #include <rtl/string.hxx>
  35 #include <rtl/strbuf.hxx>
  36 #include "export.hxx"
  37 #include <unordered_map>
  38
  39 class XMLParentNode;
  40 class XMLElement;
  41
  42 enum class XMLNodeType{
  43     XFILE   = 0x001,
  44     ELEMENT = 0x002,
  45     DATA    = 0x003,
  46     COMMENT = 0x004,
  47     DEFAULT = 0x005
  48 };
  49
  50 /** Holds data of Attributes
  51  */
  52 class XMLAttribute
  53 {
  54 private:
  55     OString m_sName;
  56     OString m_sValue;
  57
  58 public:
  59     /// creates an attribute
  60     XMLAttribute(
  61         const OString &rName,    // attributes name
  62         const OString &rValue    // attributes data
  63     )
  64     : m_sName( rName ), m_sValue( rValue ) {}
  65
  66     const OString& GetName() const { return m_sName; }
  67     const OString& GetValue() const { return m_sValue; }
  68
  69     void setValue( const OString &rValue ){ m_sValue = rValue; }
  70 };
  71
  72
  73 typedef std::vector< XMLAttribute* > XMLAttributeList;
  74
  75 /** Virtual base to handle different kinds of XML nodes
  76  */
  77 class XMLNode
  78 {
  79 protected:
  80     XMLNode(){}
  81
  82 public:
  83     virtual XMLNodeType GetNodeType() const = 0;
  84     virtual ~XMLNode(){}
  85
  86     XMLNode(XMLNode const &) = default;
  87     XMLNode(XMLNode &&) = default;
  88     XMLNode & operator =(XMLNode const &) = default;
  89     XMLNode & operator =(XMLNode &&) = default;
  90 };
  91
  92
  93 /** Virtual base to handle different kinds of child nodes
  94  */
  95 class XMLChildNode : public XMLNode
  96 {
  97 private:
  98     XMLParentNode *m_pParent;
  99
 100 protected:
 101     XMLChildNode( XMLParentNode *pPar );
 102     XMLChildNode( const XMLChildNode& rObj);
 103     XMLChildNode& operator=(const XMLChildNode& rObj);
 104 public:
 105     /// returns the parent of this node
 106     XMLParentNode *GetParent() { return m_pParent; }
 107 };
 108
 109 typedef std::vector< XMLChildNode* > XMLChildNodeList;
 110
 111 class XMLData;
 112
 113 /** Virtual base to handle different kinds of parent nodes
 114  */
 115
 116 class XMLParentNode : public XMLChildNode
 117 {
 118 private:
 119     std::unique_ptr<XMLChildNodeList> m_pChildList;
 120
 121 protected:
 122     XMLParentNode( XMLParentNode *pPar )
 123         : XMLChildNode( pPar ) {}
 124
 125     XMLParentNode( const XMLParentNode& );
 126
 127     XMLParentNode& operator=(const XMLParentNode& rObj);
 128     virtual ~XMLParentNode() override;
 129
 130 public:
 131     /// returns child list of this node
 132     XMLChildNodeList *GetChildList() { return m_pChildList.get(); }
 133
 134     /// adds a new child
 135     void AddChild(
 136         XMLChildNode *pChild    /// the new child
 137     );
 138
 139     void RemoveAndDeleteAllChildren();
 140 };
 141
 142 /// Mapping numeric Language code <-> XML Element
 143 typedef std::unordered_map<OString, XMLElement*> LangHashMap;
 144
 145 /// Mapping XML Element string identifier <-> Language Map
 146 typedef std::unordered_map<OString, LangHashMap*> XMLHashMap;
 147
 148 /** Holds information of a XML file, is root node of tree
 149  */
 150 class XMLFile final : public XMLParentNode
 151 {
 152 public:
 153     XMLFile(
 154         const OString &rFileName // the file name, empty if created from memory stream
 155     );
 156     XMLFile( const XMLFile& rObj ) ;
 157     virtual ~XMLFile() override;
 158
 159     void Print( XMLNode *pCur, sal_uInt16 nLevel = 0 );
 160     void SearchL10NElements( XMLChildNode *pCur );
 161     void Extract();
 162
 163     XMLHashMap* GetStrings(){ return m_pXMLStrings.get(); }
 164     void Write( OString const &rFilename );
 165     void Write( std::ofstream &rStream, XMLNode *pCur = nullptr );
 166
 167     bool CheckExportStatus( XMLParentNode *pCur = nullptr );
 168
 169     XMLFile& operator=(const XMLFile& rObj);
 170
 171     virtual XMLNodeType GetNodeType() const override { return XMLNodeType::XFILE; }
 172
 173     /// returns file name
 174     const OString& GetName() const { return m_sFileName; }
 175     void SetName( const OString &rFilename ) { m_sFileName = rFilename; }
 176     const std::vector<OString>& getOrder() const { return m_vOrder; }
 177
 178 private:
 179
 180     void InsertL10NElement( XMLElement* pElement);
 181
 182     // DATA
 183     OString m_sFileName;
 184
 185     /// Mapping XML tag names <-> have localizable strings
 186     std::unordered_map<OString, bool> m_aNodes_localize;
 187
 188     std::unique_ptr<XMLHashMap> m_pXMLStrings;
 189
 190     std::vector <OString> m_vOrder;
 191 };
 192
 193 /// A Utility class for XML
 194 class XMLUtil
 195 {
 196 public:
 197     /// Quot the XML characters
 198     static OString QuotHTML( const OString& rString );
 199 };
 200
 201
 202 /** Hold information of an element node
 203  */
 204 class XMLElement : public XMLParentNode
 205 {
 206 private:
 207     OString m_sElementName;
 208     std::unique_ptr<XMLAttributeList> m_pAttributes;
 209
 210 protected:
 211     void Print(XMLNode *pCur, OStringBuffer& rBuffer, bool bRootelement) const;
 212 public:
 213     /// create an element node
 214     XMLElement(
 215         const OString &rName,    // the element name
 216         XMLParentNode *pParent   // parent node of this element
 217     );
 218
 219     virtual ~XMLElement() override;
 220     XMLElement(const XMLElement&);
 221
 222     XMLElement& operator=(const XMLElement& rObj);
 223     virtual XMLNodeType GetNodeType() const override { return XMLNodeType::ELEMENT; }
 224
 225     /// returns element name
 226     const OString& GetName() const { return m_sElementName; }
 227
 228     /// returns list of attributes of this element
 229     XMLAttributeList *GetAttributeList() { return m_pAttributes.get(); }
 230
 231     /// adds a new attribute to this element, typically used by parser
 232     void AddAttribute( const OString &rAttribute, const OString &rValue );
 233
 234     void ChangeLanguageTag( const OString &rValue );
 235
 236     /// Return a Unicode String representation of this object
 237     OString ToOString();
 238 };
 239
 240 /** Holds character data
 241  */
 242 class XMLData : public XMLChildNode
 243 {
 244 private:
 245     OString m_sData;
 246
 247 public:
 248     /// create a data node
 249     XMLData(
 250         const OString &rData,    // the initial data
 251         XMLParentNode *pParent   // the parent node of this data, typically an element node
 252     )
 253         : XMLChildNode( pParent ), m_sData( rData ) {}
 254
 255     // Default copy constructor and copy operator work well.
 256
 257     virtual XMLNodeType GetNodeType() const override { return XMLNodeType::DATA; }
 258
 259     /// returns the data
 260     const OString& GetData() const { return m_sData; }
 261
 262     /// adds new character data to the existing one
 263     void AddData( const OString &rData ) { m_sData += rData; }
 264 };
 265
 266 /** Holds comments
 267  */
 268 class XMLComment final : public XMLChildNode
 269 {
 270 private:
 271     OString m_sComment;
 272
 273 public:
 274     /// create a comment node
 275     XMLComment(
 276         const OString &rComment, // the comment
 277         XMLParentNode *pParent   // the parent node of this comemnt, typically an element node
 278     )
 279         : XMLChildNode( pParent ), m_sComment( rComment ) {}
 280
 281     // Default copy constructor and copy operator work well.
 282
 283     virtual XMLNodeType GetNodeType() const override { return XMLNodeType::COMMENT; }
 284
 285     /// returns the comment
 286     const OString& GetComment() const { return m_sComment; }
 287 };
 288
 289 /** Holds additional file content like those for which no handler exists
 290  */
 291 class XMLDefault final : public XMLChildNode
 292 {
 293 private:
 294     OString m_sDefault;
 295
 296 public:
 297     /// create a comment node
 298     XMLDefault(
 299         const OString &rDefault, // the comment
 300         XMLParentNode *pParent   // the parent node of this comemnt, typically an element node
 301     )
 302         : XMLChildNode( pParent ), m_sDefault( rDefault ) {}
 303
 304     // Default copy constructor and copy operator work well.
 305
 306     virtual XMLNodeType GetNodeType() const override { return XMLNodeType::DEFAULT; }
 307
 308     /// returns the comment
 309     const OString& GetDefault() const { return m_sDefault; }
 310 };
 311
 312 /** struct for error information, used by class SimpleXMLParser
 313  */
 314 struct XMLError {
 315     XML_Error m_eCode;    ///< the error code
 316     std::size_t m_nLine; ///< error line number
 317     std::size_t m_nColumn; ///< error column number
 318     OString m_sMessage;    ///< readable error message
 319 };
 320
 321 /** validating xml parser, creates a document tree with xml nodes
 322  */
 323
 324 class SimpleXMLParser
 325 {
 326 private:
 327     XML_Parser m_aParser;
 328     XMLError m_aErrorInformation;
 329
 330     XMLParentNode *m_pCurNode;
 331     XMLData *m_pCurData;
 332
 333
 334     static void StartElementHandler( void *userData, const XML_Char *name, const XML_Char **atts );
 335     static void EndElementHandler( void *userData, const XML_Char *name );
 336     static void CharacterDataHandler( void *userData, const XML_Char *s, int len );
 337     static void CommentHandler( void *userData, const XML_Char *data );
 338     static void DefaultHandler( void *userData, const XML_Char *s, int len );
 339
 340
 341     void StartElement( const XML_Char *name, const XML_Char **atts );
 342     void EndElement();
 343     void CharacterData( const XML_Char *s, int len );
 344     void Comment( const XML_Char *data );
 345     void Default( const XML_Char *s, int len );
 346
 347 public:
 348     /// creates a new parser
 349     SimpleXMLParser();
 350     ~SimpleXMLParser();
 351
 352     /// parse a file, return false on critical errors
 353     bool Execute(
 354         const OString &rFileName,    // the file name
 355         XMLFile* pXMLFile  // the XMLFile
 356     );
 357
 358     /// returns an error struct
 359     const XMLError &GetError() const { return m_aErrorInformation; }
 360 };
 361
 362 #endif // INCLUDED_L10NTOOLS_INC_XMLPARSE_HXX
 363
 364 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */