Orcus
document.hpp
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This Source Code Form is subject to the terms of the Mozilla Public
4  * License, v. 2.0. If a copy of the MPL was not distributed with this
5  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
6  */
7 
8 #ifndef INCLUDED_ORCUS_SPREADSHEET_DOCUMENT_HPP
9 #define INCLUDED_ORCUS_SPREADSHEET_DOCUMENT_HPP
10 
11 #include "orcus/env.hpp"
12 #include "orcus/interface.hpp"
13 #include "orcus/spreadsheet/types.hpp"
14 
15 #include <ostream>
16 #include <memory>
17 
18 namespace ixion {
19 
20 class formula_name_resolver;
21 class model_context;
22 struct abs_address_t;
23 
24 }
25 
26 namespace orcus {
27 
28 class pstring;
29 class string_pool;
30 struct date_time_t;
31 
32 namespace spreadsheet {
33 
34 class import_shared_strings;
35 class styles;
36 class pivot_collection;
37 class sheet;
38 
39 struct document_config;
40 struct table_t;
41 struct document_impl;
42 
47 class ORCUS_SPM_DLLPUBLIC document : public orcus::iface::document_dumper
48 {
49  friend class sheet;
50 
51 public:
52  document(const document&) = delete;
53  document& operator= (const document&) = delete;
54 
55  document(const range_size_t& sheet_size);
56  ~document();
57 
58  import_shared_strings* get_shared_strings();
59  const import_shared_strings* get_shared_strings() const;
60 
61  styles& get_styles();
62  const styles& get_styles() const;
63 
64  pivot_collection& get_pivot_collection();
65  const pivot_collection& get_pivot_collection() const;
66 
67  sheet* append_sheet(const pstring& sheet_name);
68  sheet* get_sheet(const pstring& sheet_name);
69  const sheet* get_sheet(const pstring& sheet_name) const;
70  sheet* get_sheet(sheet_t sheet_pos);
71  const sheet* get_sheet(sheet_t sheet_pos) const;
72 
76  void clear();
77 
83 
84  virtual void dump(dump_format_t format, const std::string& output) const override;
85 
89  void dump_flat(const std::string& outdir) const;
90 
97  void dump_html(const ::std::string& outdir) const;
98 
99  void dump_json(const ::std::string& outdir) const;
100 
101  void dump_csv(const std::string& outdir) const;
102 
107  virtual void dump_check(std::ostream& os) const override;
108 
109  sheet_t get_sheet_index(const pstring& name) const;
110  pstring get_sheet_name(sheet_t sheet_pos) const;
111 
112  range_size_t get_sheet_size() const;
113  void set_sheet_size(const range_size_t& sheet_size);
114  size_t get_sheet_count() const;
115 
116  void set_origin_date(int year, int month, int day);
117  date_time_t get_origin_date() const;
118 
119  void set_formula_grammar(formula_grammar_t grammar);
120  formula_grammar_t get_formula_grammar() const;
121 
122  const ixion::formula_name_resolver* get_formula_name_resolver(formula_ref_context_t cxt) const;
123 
124  ixion::model_context& get_model_context();
125  const ixion::model_context& get_model_context() const;
126 
127  const document_config& get_config() const;
128  void set_config(const document_config& cfg);
129 
130  string_pool& get_string_pool();
131 
141 
142  const table_t* get_table(const pstring& name) const;
143 
144  void finalize();
145 
146 private:
147  void insert_dirty_cell(const ixion::abs_address_t& pos);
148 
149 private:
150  std::unique_ptr<document_impl> mp_impl;
151 };
152 
153 }}
154 
155 #endif
156 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Definition: interface.hpp:45
Definition: pstring.hpp:28
Definition: document.hpp:48
void dump_flat(const std::string &outdir) const
virtual void dump_check(std::ostream &os) const override
void dump_html(const ::std::string &outdir) const
void insert_table(table_t *p)
Definition: shared_strings.hpp:52
Definition: pivot.hpp:267
Definition: sheet.hpp:36
Definition: styles.hpp:150
Definition: string_pool.hpp:24
Definition: types.hpp:445
Definition: config.hpp:18
Definition: types.hpp:398
Definition: auto_filter.hpp:99