FWStruct.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  * basic structure used to code zone when converting FullWrite document
36  *
37  */
38 #ifndef FP_MWAW_STRUCT
39 # define FP_MWAW_STRUCT
40 
41 #include <libwpd/libwpd.h>
42 
43 #include "libmwaw_internal.hxx"
44 
45 #include "MWAWDebug.hxx"
46 #include "MWAWEntry.hxx"
47 
49 namespace FWStruct
50 {
51 
52 // basic
53 struct Entry;
55 bool getColor(int color, MWAWColor &col);
57 std::string getTypeName(int type);
58 
60 struct Border {
63  m_width(0), m_isDouble(0), m_flags(0), m_extra("") {
64  for (int w=0; w < 3; w++) m_type[w]=0;
65  }
66 
68  static MWAWBorder getBorder(int type);
70  bool read(shared_ptr<FWStruct::Entry> zone, int fSz);
72  std::vector<Variable<MWAWBorder> > getParagraphBorders() const;
74  friend std::ostream &operator<<(std::ostream &o, Border const &p);
76  int m_type[3];
84  int m_width;
88  int m_flags;
90  std::string m_extra;
91 };
92 
94 struct Entry : public MWAWEntry {
96  ~Entry();
97 
99  friend std::ostream &operator<<(std::ostream &o, Entry const &entry);
100 
102  bool valid() const;
104  void update();
106  void closeDebugFile();
107 
111  bool operator==(const Entry &a) const;
113  bool operator!=(const Entry &a) const {
114  return !operator==(a);
115  }
116 
120  int m_nextId;
122  int m_type;
124  int m_typeId;
126  int m_values[3];
128  WPXBinaryData m_data;
130  shared_ptr<libmwaw::DebugFile> m_asciiFile;
131 private:
132  Entry(Entry const &);
133  Entry &operator=(Entry const &);
134 };
135 typedef shared_ptr<Entry> EntryPtr;
136 
138 struct ZoneHeader {
140  ZoneHeader() : m_type(-1), m_docId(-1), m_fileId(-1), m_wrapping(-1), m_extra("") {}
142  virtual ~ZoneHeader() { }
144  bool read(shared_ptr<FWStruct::Entry> zone);
146  friend std::ostream &operator<<(std::ostream &o, ZoneHeader const &dt);
148  int m_type;
150  int m_docId;
152  int m_fileId;
156  std::string m_extra;
157 };
158 }
159 
160 #endif
161 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
int m_type
the zone type
Definition: FWStruct.hxx:148
shared_ptr< Entry > EntryPtr
Definition: FWStruct.hxx:135
MWAWColor m_color[2]
the colors line + ?
Definition: FWStruct.hxx:82
Entry & operator=(Entry const &)
int m_fileId
the file id
Definition: FWStruct.hxx:152
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:67
int m_docId
the doc id
Definition: FWStruct.hxx:150
a structure used to store the data of a zone header in a FullWrite file
Definition: FWStruct.hxx:138
the definition of a zone in a FullWrite file
Definition: FWStruct.hxx:94
int m_type[3]
the type (border, horizontal and vertical separators)
Definition: FWStruct.hxx:76
int m_typeId
the type id (find in FZoneFlags)
Definition: FWStruct.hxx:124
Border()
constructor
Definition: FWStruct.hxx:62
int m_values[3]
some unknown values
Definition: FWStruct.hxx:126
int m_wrapping
the wrapping type
Definition: FWStruct.hxx:154
friend std::ostream & operator<<(std::ostream &o, Entry const &entry)
operator&lt;&lt;
Definition: FWStruct.cxx:275
std::vector< Variable< MWAWBorder > > getParagraphBorders() const
returns the list of border order MWAWBorder::Pos
Definition: FWStruct.cxx:185
bool read(shared_ptr< FWStruct::Entry > zone, int fSz)
try to read a border definiton
Definition: FWStruct.cxx:125
bool getColor(int color, MWAWColor &col)
try to convert a file data to a color
Definition: FWStruct.cxx:44
the class to store a color
Definition: libmwaw_internal.hxx:161
void update()
create a inputstream, ... if needed
Definition: FWStruct.cxx:309
static MWAWBorder getBorder(int type)
return a border corresponding to a type
Definition: FWStruct.cxx:116
Entry(MWAWInputStreamPtr input)
Definition: FWStruct.cxx:265
friend std::ostream & operator<<(std::ostream &o, Border const &p)
operator&lt;&lt;
Definition: FWStruct.cxx:204
a border
Definition: libmwaw_internal.hxx:232
MWAWInputStreamPtr m_input
the input
Definition: FWStruct.hxx:118
int m_isDouble
the f1 value: isDouble ?
Definition: FWStruct.hxx:86
friend std::ostream & operator<<(std::ostream &o, ZoneHeader const &dt)
the operator&lt;&lt;
Definition: FWStruct.cxx:460
std::string getTypeName(int type)
returns the type name
Definition: FWStruct.cxx:64
ZoneHeader()
constructor
Definition: FWStruct.hxx:140
~Entry()
Definition: FWStruct.cxx:270
libmwaw::DebugFile & getAsciiFile()
returns a reference to the ascii file
Definition: FWStruct.cxx:335
bool operator==(const Entry &a) const
basic operator==
Definition: FWStruct.cxx:340
int m_width
the width
Definition: FWStruct.hxx:84
int m_type
the zone type id find in DStruct
Definition: FWStruct.hxx:122
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:336
virtual ~ZoneHeader()
destructor
Definition: FWStruct.hxx:142
Internal: class to store a border which appear in docInfo.
Definition: FWStruct.hxx:60
MWAWColor m_frontColor
the front color (used for layout )
Definition: FWStruct.hxx:78
std::string m_extra
some extra data
Definition: FWStruct.hxx:156
int m_nextId
the next entry id
Definition: FWStruct.hxx:120
bool valid() const
returns true if the entry and the input is valid
Definition: FWStruct.cxx:304
MWAWColor m_backColor
the back color (used for layout )
Definition: FWStruct.hxx:80
std::string m_extra
some extra data
Definition: FWStruct.hxx:90
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
WPXBinaryData m_data
the main data ( if the entry comes from several zone )
Definition: FWStruct.hxx:128
shared_ptr< libmwaw::DebugFile > m_asciiFile
the debug file
Definition: FWStruct.hxx:130
bool read(shared_ptr< FWStruct::Entry > zone)
try to read the data header of a classical zone
Definition: FWStruct.cxx:356
int m_flags
the flags
Definition: FWStruct.hxx:88
bool operator!=(const Entry &a) const
basic operator!=
Definition: FWStruct.hxx:113
void closeDebugFile()
write the debug file, ...
Definition: FWStruct.cxx:329

Generated on Wed Jun 11 2014 01:30:57 for libmwaw by doxygen 1.8.5