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