MWAWDebug.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 #ifndef MWAW_DEBUG
35 # define MWAW_DEBUG
36 
37 #include <string>
38 
39 #include "MWAWInputStream.hxx"
40 
41 # if defined(DEBUG_WITH_FILES)
42 #include <fstream>
43 #include <sstream>
44 #include <vector>
46 namespace libmwaw
47 {
49 namespace Debug
50 {
54 bool dumpFile(librevenge::RVNGBinaryData &data, char const *fileName);
56 std::string flattenFileName(std::string const &name);
57 }
58 
60 typedef std::stringstream DebugStream;
61 
64 class DebugFile
65 {
66 public:
69  : m_file(), m_on(false), m_input(ip), m_actOffset(-1), m_notes(), m_skipZones() { }
70 
73  {
74  m_input = ip;
75  }
78  {
79  reset();
80  }
82  bool open(std::string const &filename);
84  void reset()
85  {
86  write();
87  m_file.close();
88  m_on = false;
89  m_notes.resize(0);
90  m_skipZones.resize(0);
91  m_actOffset = -1;
92  }
94  void write();
96  void addPos(long pos);
98  void addNote(char const *note);
100  void addDelimiter(long pos, char c);
101 
103  void skipZone(long beginPos, long endPos)
104  {
105  if (m_on) m_skipZones.push_back(Vec2<long>(beginPos, endPos));
106  }
107 
108 protected:
110  void sort();
111 
113  mutable std::ofstream m_file;
115  mutable bool m_on;
116 
119 
121  struct NotePos {
123  NotePos() : m_pos(-1), m_text(""), m_breaking(false) { }
124 
126  NotePos(long p, std::string const &n, bool br=true) : m_pos(p), m_text(n), m_breaking(br) {}
128  long m_pos;
130  std::string m_text;
133 
135  bool operator<(NotePos const &p) const
136  {
137  long diff = m_pos-p.m_pos;
138  if (diff) return (diff < 0) ? true : false;
139  if (m_breaking != p.m_breaking) return m_breaking;
140  return m_text < p.m_text;
141  }
145  struct NotePosLt {
147  bool operator()(NotePos const &s1, NotePos const &s2) const
148  {
149  return s1 < s2;
150  }
151  };
152  };
153 
157  std::vector<NotePos> m_notes;
159  std::vector<Vec2<long> > m_skipZones;
160 };
161 }
162 # else
163 namespace libmwaw
164 {
165 namespace Debug
166 {
167 inline bool dumpFile(librevenge::RVNGBinaryData &, char const *)
168 {
169  return true;
170 }
172 inline std::string flattenFileName(std::string const &name)
173 {
174  return name;
175 }
176 }
177 
178 class DebugStream
179 {
180 public:
181  template <class T>
182  DebugStream &operator<<(T const &)
183  {
184  return *this;
185  }
186 
187  static std::string str()
188  {
189  return std::string("");
190  }
191  static void str(std::string const &) { }
192 };
193 
194 class DebugFile
195 {
196 public:
198  DebugFile() {}
199  static void setStream(MWAWInputStreamPtr) { }
200  ~DebugFile() { }
201 
202  static bool open(std::string const &)
203  {
204  return true;
205  }
206 
207  static void addPos(long) {}
208  static void addNote(char const *) {}
209  static void addDelimiter(long, char) {}
210 
211  static void write() {}
212  static void reset() { }
213 
214  static void skipZone(long , long) {}
215 };
216 }
217 # endif
218 
219 #endif
220 
221 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
void skipZone(long beginPos, long endPos)
skips the file zone defined by beginPos-endPos
Definition: MWAWDebug.hxx:103
void write()
flushes the file
Definition: MWAWDebug.cxx:113
NotePos(long p, std::string const &n, bool br=true)
constructor: given position and note
Definition: MWAWDebug.hxx:126
void setStream(MWAWInputStreamPtr ip)
resets the input
Definition: MWAWDebug.hxx:72
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:64
void sort()
sorts the position/note date
Definition: MWAWDebug.cxx:82
std::ostream & operator<<(std::ostream &o, PrinterInfo const &r)
operator<< for a PrinterInfo
Definition: MWAWPrinter.cxx:211
a note and its position (used to sort all notes)
Definition: MWAWDebug.hxx:121
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:47
bool operator<(NotePos const &p) const
comparison operator based on the position
Definition: MWAWDebug.hxx:135
bool dumpFile(librevenge::RVNGBinaryData &data, char const *fileName)
a debug function to store in a datafile in the current directory WARNING: this function erase the fil...
Definition: MWAWDebug.cxx:193
bool m_breaking
flag to indicate a non breaking note
Definition: MWAWDebug.hxx:132
long m_actOffset
the actual offset (used to store note)
Definition: MWAWDebug.hxx:155
std::string m_text
note text
Definition: MWAWDebug.hxx:130
bool open(std::string const &filename)
opens/creates a file to store a result
Definition: MWAWDebug.cxx:46
void addDelimiter(long pos, char c)
adds a not breaking delimiter in position pos
Definition: MWAWDebug.cxx:74
void addPos(long pos)
adds a new position in the file
Definition: MWAWDebug.cxx:54
std::vector< NotePos > m_notes
list of notes
Definition: MWAWDebug.hxx:157
internal struct used to sort the notes, sorted by position
Definition: MWAWDebug.hxx:145
NotePos()
empty constructor used by std::vector
Definition: MWAWDebug.hxx:123
DebugFile(MWAWInputStreamPtr ip=MWAWInputStreamPtr())
constructor given the input file
Definition: MWAWDebug.hxx:68
~DebugFile()
destructor
Definition: MWAWDebug.hxx:77
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:380
MWAWInputStreamPtr m_input
the input
Definition: MWAWDebug.hxx:118
std::ofstream m_file
a stream which is open to write the file
Definition: MWAWDebug.hxx:113
std::string flattenFileName(std::string const &name)
returns a file name from an ole/... name
Definition: MWAWDebug.cxx:208
void reset()
writes the current file and reset to zero
Definition: MWAWDebug.hxx:84
std::vector< Vec2< long > > m_skipZones
list of skipZone
Definition: MWAWDebug.hxx:159
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:60
long m_pos
note offset
Definition: MWAWDebug.hxx:128
bool m_on
a flag to know if the result stream is open or note
Definition: MWAWDebug.hxx:115
bool operator()(NotePos const &s1, NotePos const &s2) const
comparison operator
Definition: MWAWDebug.hxx:147
void addNote(char const *note)
adds a note in the file, in actual position
Definition: MWAWDebug.cxx:60

Generated on Wed Jun 7 2017 22:16:22 for libmwaw by doxygen 1.8.8