Line data Source code
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 HELPCOMPILER_HXX
21 : #define HELPCOMPILER_HXX
22 :
23 : #include <config_global.h>
24 :
25 : #include <string>
26 : #if !HAVE_CXX11
27 : #define BOOST_NO_0X_HDR_TYPEINDEX
28 : #endif
29 : #include <boost/unordered_map.hpp>
30 : #include <vector>
31 : #include <list>
32 : #include <fstream>
33 : #include <sstream>
34 : #include <algorithm>
35 : #include <ctype.h>
36 :
37 : #include <boost/shared_ptr.hpp>
38 :
39 : #include <libxml/xmlmemory.h>
40 : #include <libxml/debugXML.h>
41 : #include <libxml/HTMLtree.h>
42 : #include <libxml/xmlIO.h>
43 : #include <libxml/xinclude.h>
44 : #include <libxml/catalog.h>
45 :
46 : #include <rtl/ustring.hxx>
47 : #include <osl/thread.h>
48 : #include <osl/process.h>
49 : #include <osl/file.hxx>
50 :
51 : #include <helpcompiler/compilehelp.hxx>
52 :
53 : #if OSL_DEBUG_LEVEL > 2
54 : #include <iostream>
55 : #define HCDBG(foo) do { if (true) foo; } while(false)
56 : #else
57 : #define HCDBG(foo) do { } while(false)
58 : #endif
59 :
60 : namespace fs
61 : {
62 : rtl_TextEncoding getThreadTextEncoding( void );
63 :
64 : enum convert { native };
65 0 : class path
66 : {
67 : public:
68 : OUString data;
69 : public:
70 0 : path() {}
71 0 : path(const path &rOther) : data(rOther.data) {}
72 0 : path(const std::string &in, convert)
73 0 : {
74 0 : OUString sWorkingDir;
75 0 : osl_getProcessWorkingDir(&sWorkingDir.pData);
76 0 : OString tmp(in.c_str());
77 0 : OUString ustrSystemPath(OStringToOUString(tmp, getThreadTextEncoding()));
78 0 : osl::File::getFileURLFromSystemPath(ustrSystemPath, data);
79 0 : osl::File::getAbsoluteFileURL(sWorkingDir, data, data);
80 0 : }
81 0 : path(const std::string &FileURL)
82 0 : {
83 0 : OString tmp(FileURL.c_str());
84 0 : data = OStringToOUString(tmp, getThreadTextEncoding());
85 0 : }
86 0 : std::string native_file_string() const
87 : {
88 0 : OUString ustrSystemPath;
89 0 : osl::File::getSystemPathFromFileURL(data, ustrSystemPath);
90 0 : OString tmp(OUStringToOString(ustrSystemPath, getThreadTextEncoding()));
91 : HCDBG(std::cerr << "native_file_string is " << tmp.getStr() << std::endl);
92 0 : return std::string(tmp.getStr());
93 : }
94 : #ifdef WNT
95 : wchar_t const * native_file_string_w() const
96 : {
97 : OUString ustrSystemPath;
98 : osl::File::getSystemPathFromFileURL(data, ustrSystemPath);
99 : return (wchar_t const *) ustrSystemPath.getStr();
100 : }
101 : #endif
102 : std::string native_directory_string() const { return native_file_string(); }
103 0 : std::string toUTF8() const
104 : {
105 0 : OString tmp(OUStringToOString(data, RTL_TEXTENCODING_UTF8));
106 0 : return std::string(tmp.getStr());
107 : }
108 0 : bool empty() const { return data.isEmpty(); }
109 0 : path operator/(const std::string &in) const
110 : {
111 0 : path ret(*this);
112 : HCDBG(std::cerr << "orig was " <<
113 : OUStringToOString(ret.data, RTL_TEXTENCODING_UTF8).getStr() << std::endl);
114 0 : OString tmp(in.c_str());
115 0 : OUString ustrSystemPath(OStringToOUString(tmp, getThreadTextEncoding()));
116 0 : ret.data += OUString(sal_Unicode('/'));
117 0 : ret.data += ustrSystemPath;
118 : HCDBG(std::cerr << "final is " <<
119 : OUStringToOString(ret.data, RTL_TEXTENCODING_UTF8).getStr() << std::endl);
120 0 : return ret;
121 : }
122 0 : void append(const char *in)
123 : {
124 0 : OString tmp(in);
125 0 : OUString ustrSystemPath(OStringToOUString(tmp, getThreadTextEncoding()));
126 0 : data = data + ustrSystemPath;
127 0 : }
128 0 : void append(const std::string &in) { append(in.c_str()); }
129 : };
130 :
131 : void create_directory(const fs::path indexDirName);
132 : void copy(const fs::path &src, const fs::path &dest);
133 : }
134 :
135 : struct joaat_hash
136 : {
137 0 : size_t operator()(const std::string &str) const
138 : {
139 0 : size_t hash = 0;
140 0 : const char *key = str.data();
141 0 : for (size_t i = 0; i < str.size(); i++)
142 : {
143 0 : hash += key[i];
144 0 : hash += (hash << 10);
145 0 : hash ^= (hash >> 6);
146 : }
147 0 : hash += (hash << 3);
148 0 : hash ^= (hash >> 11);
149 0 : hash += (hash << 15);
150 0 : return hash;
151 : }
152 : };
153 :
154 : #define get16bits(d) ((((sal_uInt32)(((const sal_uInt8 *)(d))[1])) << 8)\
155 : +(sal_uInt32)(((const sal_uInt8 *)(d))[0]) )
156 :
157 : #define pref_hash joaat_hash
158 :
159 : typedef boost::unordered_map<std::string, std::string, pref_hash> Stringtable;
160 : typedef std::list<std::string> LinkedList;
161 : typedef std::vector<std::string> HashSet;
162 :
163 : typedef boost::unordered_map<std::string, LinkedList, pref_hash> Hashtable;
164 :
165 : class StreamTable
166 : {
167 : public:
168 : std::string document_id;
169 : std::string document_path;
170 : std::string document_module;
171 : std::string document_title;
172 :
173 : HashSet *appl_hidlist;
174 : Hashtable *appl_keywords;
175 : Stringtable *appl_helptexts;
176 : xmlDocPtr appl_doc;
177 :
178 : HashSet *default_hidlist;
179 : Hashtable *default_keywords;
180 : Stringtable *default_helptexts;
181 : xmlDocPtr default_doc;
182 :
183 0 : StreamTable() :
184 : appl_hidlist(NULL), appl_keywords(NULL), appl_helptexts(NULL), appl_doc(NULL),
185 0 : default_hidlist(NULL), default_keywords(NULL), default_helptexts(NULL), default_doc(NULL)
186 0 : {}
187 0 : void dropdefault()
188 : {
189 0 : delete default_hidlist;
190 0 : delete default_keywords;
191 0 : delete default_helptexts;
192 0 : if (default_doc) xmlFreeDoc(default_doc);
193 0 : }
194 0 : void dropappl()
195 : {
196 0 : delete appl_hidlist;
197 0 : delete appl_keywords;
198 0 : delete appl_helptexts;
199 0 : if (appl_doc) xmlFreeDoc(appl_doc);
200 0 : }
201 0 : ~StreamTable()
202 0 : {
203 0 : dropappl();
204 0 : dropdefault();
205 0 : }
206 : };
207 :
208 0 : struct HelpProcessingException
209 : {
210 : HelpProcessingErrorClass m_eErrorClass;
211 : std::string m_aErrorMsg;
212 : std::string m_aXMLParsingFile;
213 : int m_nXMLParsingLine;
214 :
215 0 : HelpProcessingException( HelpProcessingErrorClass eErrorClass, const std::string& aErrorMsg )
216 : : m_eErrorClass( eErrorClass )
217 : , m_aErrorMsg( aErrorMsg )
218 0 : , m_nXMLParsingLine( 0 )
219 0 : {}
220 0 : HelpProcessingException( const std::string& aErrorMsg, const std::string& aXMLParsingFile, int nXMLParsingLine )
221 : : m_eErrorClass( HELPPROCESSING_XMLPARSING_ERROR )
222 : , m_aErrorMsg( aErrorMsg )
223 : , m_aXMLParsingFile( aXMLParsingFile )
224 0 : , m_nXMLParsingLine( nXMLParsingLine )
225 0 : {}
226 : };
227 :
228 0 : class HelpCompiler
229 : {
230 : public:
231 : HelpCompiler(StreamTable &streamTable,
232 : const fs::path &in_inputFile,
233 : const fs::path &in_src,
234 : const fs::path &in_zipdir,
235 : const fs::path &in_resCompactStylesheet,
236 : const fs::path &in_resEmbStylesheet,
237 : const std::string &in_module,
238 : const std::string &in_lang,
239 : bool in_bExtensionMode);
240 : bool compile( void ) throw (HelpProcessingException);
241 : void addEntryToJarFile(const std::string &prefix,
242 : const std::string &entryName, const std::string &bytesToAdd);
243 : void addEntryToJarFile(const std::string &prefix,
244 : const std::string &entryName, const HashSet &bytesToAdd);
245 : void addEntryToJarFile(const std::string &prefix,
246 : const std::string &entryName, const Stringtable &bytesToAdd);
247 : void addEntryToJarFile(const std::string &prefix,
248 : const std::string &entryName, const Hashtable &bytesToAdd);
249 : private:
250 : xmlDocPtr getSourceDocument(const fs::path &filePath);
251 : void tagBasicCodeExamples(xmlDocPtr doc);
252 : xmlDocPtr compactXhpForJar(xmlDocPtr doc);
253 : void saveXhpForJar(xmlDocPtr doc, const fs::path &filePath);
254 : xmlNodePtr clone(xmlNodePtr node, const std::string& appl);
255 : StreamTable &streamTable;
256 : const fs::path inputFile, src, zipdir;
257 : const std::string module, lang;
258 : const fs::path resCompactStylesheet;
259 : const fs::path resEmbStylesheet;
260 : bool bExtensionMode;
261 : std::string gui;
262 : };
263 :
264 0 : inline char tocharlower(char c)
265 : {
266 0 : return static_cast<char>(tolower(c));
267 : }
268 :
269 : #endif
270 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
