MsWrdTextStyles.hxx Source File documentation

MsWrdTextStyles.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2
3/* libmwaw
4* Version: MPL 2.0 / LGPLv2+
5*
6* The contents of this file are subject to the Mozilla Public License Version
7* 2.0 (the "License"); you may not use this file except in compliance with
8* the License or as specified alternatively below. You may obtain a copy of
9* the License at http://www.mozilla.org/MPL/
10*
11* Software distributed under the License is distributed on an "AS IS" basis,
12* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13* for the specific language governing rights and limitations under the
14* License.
15*
16* Major Contributor(s):
17* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20* Copyright (C) 2006, 2007 Andrew Ziem
21* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22*
23*
24* All Rights Reserved.
25*
26* For minor contributions see the git repository.
27*
28* Alternatively, the contents of this file may be used under the terms of
29* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30* in which case the provisions of the LGPLv2+ are applicable
31* instead of those above.
32*/
33
34/*
35 * Class to read/store the text font and paragraph styles
36 */
37
38#ifndef MS_WRD_TEXT_STYLES
39# define MS_WRD_TEXT_STYLES
40
41#include <iostream>
42#include <map>
43#include <string>
44
45#include "libmwaw_internal.hxx"
46
47#include "MWAWEntry.hxx"
48#include "MWAWParagraph.hxx"
49
50struct MsWrdEntry;
51class MsWrdParser;
52class MsWrdText;
53
54namespace MsWrdStruct
55{
56struct Font;
57struct Paragraph;
58struct Section;
59}
60
61namespace MsWrdTextStylesInternal
62{
63struct State;
64}
65
67 class MsWrdTextStyles
68{
69 friend class MsWrdText;
70public:
71 enum ZoneType { TextZone, TextStructZone, StyleZone, InParagraphDefinition };
73 explicit MsWrdTextStyles(MsWrdText &textParser);
75 virtual ~MsWrdTextStyles();
76
78 int version() const;
79
80protected:
81 // font:
83 MWAWFont const &getDefaultFont() const;
85 bool getFont(ZoneType type, int id, MsWrdStruct::Font &actFont);
86
87 /* send a font */
88 void setProperty(MsWrdStruct::Font const &font);
92 bool readFont(MsWrdStruct::Font &font, ZoneType type);
93
94 // pararagraph:
96 bool getParagraph(ZoneType type, int id, MsWrdStruct::Paragraph &para);
98 bool readParagraph(MsWrdStruct::Paragraph &para, int dataSz=-1);
100 void sendDefaultParagraph();
101
103 bool readPLCList(MsWrdEntry const &entry);
105 bool readTextStructList(MsWrdEntry &entry);
108 int readPropertyModifier(bool &complex, std::string &extra);
110 bool readPLC(MsWrdEntry &entry, int type, MWAWVec2<long> const &fileLimit);
111
112 // section:
114 bool getSection(ZoneType type, int id, MsWrdStruct::Section &section);
116 bool getSectionParagraph(ZoneType type, int id, MsWrdStruct::Paragraph &para);
118 bool getSectionFont(ZoneType type, int id, MsWrdStruct::Font &font);
120 bool readSection(MsWrdEntry &entry, std::vector<long> &cLimits);
122 bool sendSection(int id, int textStructId);
123
125 bool readSection(MsWrdStruct::Section &section, long pos);
127 void setProperty(MsWrdStruct::Section const &sec);
128
129 // style
131 bool readStyles(MsWrdEntry &entry);
133 bool readStylesHierarchy(MsWrdEntry &entry, int N, std::vector<int> &orig);
135 bool readStylesNames(MsWrdEntry const &zone, int N, int &Nnamed);
137 bool readStylesFont(MsWrdEntry &zone, int N, std::vector<int> const &previous,
138 std::vector<int> const &order);
140 bool readStylesParagraph(MsWrdEntry &zone, int N, std::vector<int> const &previous,
141 std::vector<int> const &order);
143 std::map<int,int> const &getNextStyleMap() const;
145 static std::vector<int> orderStyles(std::vector<int> const &previous);
146
147private:
148 MsWrdTextStyles(MsWrdTextStyles const &orig) = delete;
149 MsWrdTextStyles &operator=(MsWrdTextStyles const &orig) = delete;
150
151protected:
152 //
153 // data
154 //
156 MWAWParserStatePtr m_parserState;
157
159 std::shared_ptr<MsWrdTextStylesInternal::State> m_state;
160
162 MsWrdParser *m_mainParser;
163
165 MsWrdText *m_textParser;
166};
167#endif
168// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWEntry.hxx
MWAWParagraph.hxx
MWAWFont
Class to store font.
Definition MWAWFont.hxx:44
MWAWVec2
small class which defines a vector with 2 elements
Definition libmwaw_internal.hxx:656
MsWrdParser
the main class to read a Microsoft Word file
Definition MsWrdParser.hxx:98
MsWrdTextStyles::readTextStructList
bool readTextStructList(MsWrdEntry &entry)
read the paragraphs at the beginning of the text structure zone
Definition MsWrdTextStyles.cxx:806
MsWrdTextStyles::getNextStyleMap
std::map< int, int > const & getNextStyleMap() const
returns the style id to next style id map
Definition MsWrdTextStyles.cxx:1092
MsWrdTextStyles::~MsWrdTextStyles
virtual ~MsWrdTextStyles()
destructor
Definition MsWrdTextStyles.cxx:103
MsWrdTextStyles::m_textParser
MsWrdText * m_textParser
the text parser;
Definition MsWrdTextStyles.hxx:165
MsWrdTextStyles::m_state
std::shared_ptr< MsWrdTextStylesInternal::State > m_state
the state
Definition MsWrdTextStyles.hxx:159
MsWrdTextStyles::readParagraph
bool readParagraph(MsWrdStruct::Paragraph &para, int dataSz=-1)
try to read a paragraph
Definition MsWrdTextStyles.cxx:389
MsWrdTextStyles::MsWrdTextStyles
MsWrdTextStyles(MsWrdText &textParser)
constructor
Definition MsWrdTextStyles.cxx:95
MsWrdTextStyles::readStylesParagraph
bool readStylesParagraph(MsWrdEntry &zone, int N, std::vector< int > const &previous, std::vector< int > const &order)
try to read the styles fonts
Definition MsWrdTextStyles.cxx:1287
MsWrdTextStyles::getParagraph
bool getParagraph(ZoneType type, int id, MsWrdStruct::Paragraph &para)
return a paragraph corresponding to an index
Definition MsWrdTextStyles.cxx:353
MsWrdTextStyles::getSection
bool getSection(ZoneType type, int id, MsWrdStruct::Section &section)
return a section corresponding to an index
Definition MsWrdTextStyles.cxx:904
MsWrdTextStyles::getDefaultFont
MWAWFont const & getDefaultFont() const
returns the default font
Definition MsWrdTextStyles.cxx:113
MsWrdTextStyles::m_mainParser
MsWrdParser * m_mainParser
the main parser;
Definition MsWrdTextStyles.hxx:162
MsWrdTextStyles::sendSection
bool sendSection(int id, int textStructId)
try to send a section
Definition MsWrdTextStyles.cxx:1070
MsWrdTextStyles::sendDefaultParagraph
void sendDefaultParagraph()
send a default paragraph
Definition MsWrdTextStyles.cxx:383
MsWrdTextStyles::readPLC
bool readPLC(MsWrdEntry &entry, int type, MWAWVec2< long > const &fileLimit)
read the char/paragraph plc : type=0: char, type=1: parag
Definition MsWrdTextStyles.cxx:652
MsWrdTextStyles::readStylesNames
bool readStylesNames(MsWrdEntry const &zone, int N, int &Nnamed)
try to read the styles names and fill the number of "named" styles...
Definition MsWrdTextStyles.cxx:1176
MsWrdTextStyles::readSection
bool readSection(MsWrdEntry &entry, std::vector< long > &cLimits)
read the text section
Definition MsWrdTextStyles.cxx:951
MsWrdTextStyles::readPLCList
bool readPLCList(MsWrdEntry const &entry)
read the main char/paragraph plc list
Definition MsWrdTextStyles.cxx:601
MsWrdTextStyles::readPropertyModifier
int readPropertyModifier(bool &complex, std::string &extra)
read the property modifier (2 bytes last bytes of text struct ).
Definition MsWrdTextStyles.cxx:865
MsWrdTextStyles::version
int version() const
returns the file version
Definition MsWrdTextStyles.cxx:106
MsWrdTextStyles::readStylesFont
bool readStylesFont(MsWrdEntry &zone, int N, std::vector< int > const &previous, std::vector< int > const &order)
try to read the styles fonts
Definition MsWrdTextStyles.cxx:1226
MsWrdTextStyles::getSectionParagraph
bool getSectionParagraph(ZoneType type, int id, MsWrdStruct::Paragraph &para)
return a paragraph corresponding to the section
Definition MsWrdTextStyles.cxx:925
MsWrdTextStyles::MsWrdTextStyles
MsWrdTextStyles(MsWrdTextStyles const &orig)=delete
MsWrdTextStyles::readFont
bool readFont(MsWrdStruct::Font &font, ZoneType type)
try to read a font.
Definition MsWrdTextStyles.cxx:121
MsWrdTextStyles::MsWrdText
friend class MsWrdText
Definition MsWrdTextStyles.hxx:69
MsWrdTextStyles::getFont
bool getFont(ZoneType type, int id, MsWrdStruct::Font &actFont)
return a font corresponding to an index
Definition MsWrdTextStyles.cxx:304
MsWrdTextStyles::ZoneType
ZoneType
Definition MsWrdTextStyles.hxx:71
MsWrdTextStyles::TextStructZone
@ TextStructZone
Definition MsWrdTextStyles.hxx:71
MsWrdTextStyles::InParagraphDefinition
@ InParagraphDefinition
Definition MsWrdTextStyles.hxx:71
MsWrdTextStyles::TextZone
@ TextZone
Definition MsWrdTextStyles.hxx:71
MsWrdTextStyles::StyleZone
@ StyleZone
Definition MsWrdTextStyles.hxx:71
MsWrdTextStyles::readStylesHierarchy
bool readStylesHierarchy(MsWrdEntry &entry, int N, std::vector< int > &orig)
try to read the styles hierachy
Definition MsWrdTextStyles.cxx:1374
MsWrdTextStyles::readStyles
bool readStyles(MsWrdEntry &entry)
try to read the styles zone
Definition MsWrdTextStyles.cxx:1097
MsWrdTextStyles::operator=
MsWrdTextStyles & operator=(MsWrdTextStyles const &orig)=delete
MsWrdTextStyles::orderStyles
static std::vector< int > orderStyles(std::vector< int > const &previous)
try to reorder the styles to find a good order
Definition MsWrdTextStyles.cxx:1440
MsWrdTextStyles::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition MsWrdTextStyles.hxx:156
MsWrdTextStyles::getSectionFont
bool getSectionFont(ZoneType type, int id, MsWrdStruct::Font &font)
return a font corresponding to the section
Definition MsWrdTextStyles.cxx:933
MsWrdTextStyles::setProperty
void setProperty(MsWrdStruct::Font const &font)
Definition MsWrdTextStyles.cxx:340
MsWrdText
the main class to read the text part of Microsoft Word file
Definition MsWrdText.hxx:65
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition libmwaw_internal.hxx:557
MsWrdStruct
namespace to store the main structure which appears in a Microsoft Word 3.0-5.0 file
Definition MsWrdStruct.cxx:42
MsWrdTextStylesInternal
Internal: the structures of a MsWrdTextStyles.
Definition MsWrdTextStyles.cxx:46
MsWrdEntry
the entry of MsWrdParser
Definition MsWrdParser.hxx:63
MsWrdStruct::Font
the font structure of a Microsoft Word file
Definition MsWrdStruct.hxx:57
MsWrdStruct::Paragraph
the paragraph structure of a Microsoft Word file
Definition MsWrdStruct.hxx:312
MsWrdStruct::Section
the section structure of a Microsoft Word file
Definition MsWrdStruct.hxx:118
MsWrdTextStylesInternal::State
Internal: the state of a MsWrdTextStylesInternal.
Definition MsWrdTextStyles.cxx:49