summaryrefslogtreecommitdiff
path: root/graphics/epix/fmt_template.cc
blob: 3b7e4230701dbb29e78c1b022de5e057a8afd25f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
 * fmt.cc -- ePiX::fmt output format
 *
 * This file is part of ePiX, a C++ library for creating high-quality 
 * figures in LaTeX 
 *
 * Version 1.1.15
 * Last Change: September 08, 2007
 *
 * Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007
 * Andrew D. Hwang <rot 13 nujnat at zngupf dot ubylpebff dot rqh>
 * Department of Mathematics and Computer Science
 * College of the Holy Cross
 * Worcester, MA, 01610-2395, USA
 *
 *
 * ePiX is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * ePiX is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with ePiX; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#include <list>

#include <string>
#include <sstream>

#include <set>

#include "pairs.h"
#include "edge_data.h"

#include "Color.h"

#include "path_style.h"
#include "pen_data.h"

#include "format.h"
#include "fmt.h"

namespace ePiX {

  fmt::fmt() { } // modify as necessary

  fmt* fmt::clone() const
  {
    return new fmt(*this);
  }

  // Filled region with specified Cartesian edges, offset, and color
  std::string fmt::print_fill(const std::list<edge2d>& edges,
			      const pair& offset,
			      const Color& fill,
			      const pen_data& line,
			      const std::string& len) const
  {
    // Use print_paths to represent a closed polygon bounded by
    // "edges", drawn with "line" and solid "fill"-ed.
  }

  // Unfilled region, specified Cartesian edges. Should generally be
  // trivially implemented using one-pen function (supplied).
  std::string fmt::print_line(const std::list<edge2d>& edges,
			      const pair& offset,
			      const pen_data& line_pen,
			      const pen_data& base_pen,
			      const path_state& style,
			      const std::string& len) const
  {
    // Use print_paths (solid) or format::print_edges (otherwise) to
    // represent a (closed or open) polygon bounded by "edges", drawn
    // with "line" and "base" pens in the line "style".
  }

  /*
   * Default implementations provided, see format.cc. If default works
   * for the new format, remove these declarations.
  // Picture start and finish:
  // Size and offset in page units,
  // pallet (set of colors contained in the screen),
  // unitlength
  std::string fmt::pic_header(const pair& sizes,
			      const pair& offsets,
			      const std::set<Color>& pallet,
			      const std::string& len) const
  {
    // Print commands to draw a picture of specified true size and offset
  }

  std::string fmt::pic_footer() const
  {
    // Close/end the picture
  }
  */

  // Print color declaration strings: model, name, densities;
  // may simply return xdefinecolor(...) if appropriate
  std::string fmt::print_color(const std::string&,
			       const std::string&,
			       double,
			       double,
			       double) const;

  std::string fmt::print_color(const std::string&,
			       const std::string&,
			       double,
			       double,
			       double,
			       double) const;

  // One-line comment
  std::string fmt::print_comment(const std::string&) const;

  // Verbatim output
  std::string fmt::print_verbatim(const std::string&) const;


  // start/end a picture-like environment, set unit length
  std::string fmt::start_picture(const pair&, const pair&) const;
  std::string fmt::end_picture() const;

  std::string fmt::set_unitlength(const std::string& len) const;

  // reset internal state date to null
  void fmt::reset_state() const;

  //// private member functions ////

  // returns "usepackages" + [SPACE] + "comma-separated LaTeX packages"
  std::string fmt::usepackages() const
  {
    return "usepackages fmt";
  }

  // string argument for passing attributes local to this path/loop
  std::string fmt::start_open_path(const std::string&) const;
  std::string fmt::end_open_path(const std::string&) const;

  std::string fmt::start_closed_path(const std::string&) const;
  std::string fmt::end_closed_path(const std::string&) const;

  // print declarations to set state of output format
  std::string fmt::set_fill_state(const Color&) const;
  std::string fmt::set_pen_state(const pen_data&) const;

  // place a LaTeX box of width zero (containing string) at location (pair)
  std::string fmt::put_box(const pair&, const std::string&) const;

  // draw a filled or hollow circle of specified diam, color
  std::string fmt::print_circle_marker(const pair& here, double diam,
				       bool fill, const Color& color,
				       const std::string& len) const;

  //// "Optional" (implemented, but reimplementable) functions ////
  // Used to format line breaks in long paths (e.g. newline and two spaces)
  // std::string fmt::path_break() const;

  // Used between points in paths (e.g. "" or "--")
  // std::string fmt::path_connector() const;

  // std::string fmt::print_pallet(const std::set<Color>& pallet) const;

  // Represent a pair, length, or Color as a string
  // std::string fmt::print(const pair&) const;   // Default: "(a,b)"
  // std::string fmt::print(const length&) const; // Default: "3.5cm", e.g.
  // std::string fmt::print(const Color&) const;  // Default: color name

} // end of namespace