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 JAZZ_WRITER_PARSER
35 #  define JAZZ_WRITER_PARSER
36 
37 #include <set>
38 #include <string>
39 #include <vector>
40 
41 #include <librevenge/librevenge.h>
42 
43 #include "MWAWDebug.hxx"
44 #include "MWAWInputStream.hxx"
45 
46 #include "MWAWParser.hxx"
47 
48 namespace JazzWriterParserInternal
49 {
50 class SubDocument;
51 struct State;
52 }
53 
54 /** \brief the main class to read a Jazz(Lotus) word file
55  */
56 class JazzWriterParser final : public MWAWTextParser
57 {
58   friend class JazzWriterParserInternal::SubDocument;
59 public:
60   //! constructor
61   JazzWriterParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
62   //! destructor
63   ~JazzWriterParser() final;
64 
65   //! checks if the document header is correct (or not)
66   bool checkHeader(MWAWHeader *header, bool strict=false) final;
67 
68   // the main parse function
69   void parse(librevenge::RVNGTextInterface *documentInterface) final;
70 
71 protected:
72   //! creates the listener which will be associated to the document
73   void createDocument(librevenge::RVNGTextInterface *documentInterface);
74 
75   //! tries to read the WPPD zones
76   bool readParagraph(MWAWEntry const &entry);
77   //! tries to read the WSCR zones
78   bool readPLC(MWAWEntry const &entry);
79   //! tries to read the WDoc zones
80   bool readZone(MWAWEntry const &entry);
81 
82   //! try to send a zone
83   bool sendZone(unsigned zId);
84   //! try to send a paragraph
85   bool sendParagraph(unsigned pId);
86   //! try to send a plc
87   bool sendPLC(unsigned pId);
88   //! try to retrieve a picture
89   bool getPicture(unsigned pId, MWAWEmbeddedObject &obj);
90 
91 protected:
92   //! finds the different objects zones
93   bool createZones();
94   /** checks that the main zone exists (and its potential header/footer) and that there are valid.
95 
96       Enumerates also the number of characters in each zones and check that the data fork contains enough characters.
97    */
98   bool checkZones();
99   //! check that a paragraph, its style and its followings exist (and do not create loops) and update the number of characters
100   bool checkParagraphs(unsigned id, long &num, std::set<unsigned> &seens) const;
101   //! retrieve the number of characters corresponding to a PLC
102   bool countCharactersInPLC(unsigned plcId, long &n);
103 
104   //! return the input input
105   MWAWInputStreamPtr rsrcInput();
106   //! a DebugFile used to write what we recognize when we parse the document in rsrc
107   libmwaw::DebugFile &rsrcAscii();
108 
109   //
110   // data
111   //
112 
113   //! try to read a C-string
114   bool readString(MWAWInputStreamPtr input, librevenge::RVNGString &string, long endPos);
115 
116   //! the state
117   std::shared_ptr<JazzWriterParserInternal::State> m_state;
118 };
119 #endif
120 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
121