shell/inc/internal/metainforeader.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_SHELL_INC_INTERNAL_METAINFOREADER_HXX
  21 #define INCLUDED_SHELL_INC_INTERNAL_METAINFOREADER_HXX
  22
  23 #include "internal/basereader.hxx"
  24 #include "internal/types.hxx"
  25 #include <stack>
  26
  27 class ITag;
  28 class CKeywordsTag;
  29 class CSimpleTag;
  30 class CDummyTag;
  31
  32 class CMetaInfoReader : public CBaseReader
  33 {
  34 public:
  35     virtual ~CMetaInfoReader();
  36
  37     CMetaInfoReader( const std::string& DocumentName );
  38
  39     CMetaInfoReader( StreamInterface* stream );
  40
  41     /** check if the Tag is in the target meta.xml file.
  42
  43         @param TagName
  44         the name of the tag that will be retrieved.
  45     */
  46     bool hasTag(const std::wstring& TagName) const;
  47
  48
  49     /** Get a specific tag content, compound tags will be returned as comma separated list.
  50
  51         @param TagName
  52         the name of the tag that will be retrieved.
  53     */
  54     std::wstring getTagData(const std::wstring& TagName);
  55
  56     /** check if the a tag has the specific attribute.
  57
  58         @param TagName
  59         the name of the tag.
  60         @param AttributeName
  61         the name of the attribute.
  62     */
  63     bool hasTagAttribute(const std::wstring& TagName,  const std::wstring& AttributeName);
  64
  65     /** Get a specific attribute content.
  66
  67         @param TagName
  68         the name of the tag.
  69         @param AttributeName
  70         the name of the attribute.
  71     */
  72     std::wstring getTagAttribute(const std::wstring& TagName,  const std::wstring& AttributeName);
  73
  74     /** Get the default language of the whole document.
  75     */
  76     LocaleSet_t getDefaultLocale( );
  77
  78 protected: // protected because its only an implementation relevant class
  79
  80     /** start_element occurs when a tag is start.
  81
  82         @param raw_name
  83         raw name of the tag.
  84         @param local_name
  85         local name of the tag.
  86         @param attributes
  87         attribute structure.
  88     */
  89     virtual void start_element(
  90         const std::wstring& raw_name,
  91         const std::wstring& local_name,
  92         const XmlTagAttributes_t& attributes);
  93
  94     /** end_element occurs when a tag is closed
  95
  96         @param raw_name
  97         raw name of the tag.
  98         @param local_name
  99         local name of the tag.
 100     */
 101     virtual void end_element(
 102         const std::wstring& raw_name, const std::wstring& local_name);
 103
 104     /** characters occurs when receiving characters
 105
 106         @param character
 107         content of the information received.
 108     */
 109     virtual void characters(const std::wstring& character);
 110
 111 protected:
 112     /** choose an appropriate tag reader to handle the tag.
 113
 114         @param tag_name
 115         the name of the tag.
 116         @param XmlAttributes
 117         attribute structure of the tag to save in.
 118     */
 119     ITag* chooseTagReader(
 120         const std::wstring& tag_name, const XmlTagAttributes_t& XmlAttributes );
 121
 122     /** save the received content into structure.
 123
 124         @param tag_name
 125         the name of the tag.
 126     */
 127     void saveTagContent( const std::wstring& tag_name );
 128
 129 private:
 130     XmlTags_t      m_AllMetaInfo;
 131
 132 private:
 133     std::stack<ITag*> m_TagBuilderStack;
 134
 135 private:
 136     CKeywordsTag* m_pKeywords_Builder;
 137     CDummyTag*   m_pDummy_Builder;
 138     CSimpleTag* m_pSimple_Builder;
 139 };
 140
 141 #endif
 142
 143 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */