2 /* This file is part of
3 * =================================================
5 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich.
7 * Copyright 1995-2000 The LyX Team.
9 * This file Copyright 2000 Baruch Even
10 * ================================================= */
15 #pragma implementation
18 #include "insetgraphicsParams.h"
20 #include "support/translator.h"
21 #include "support/filetools.h"
23 #include "support/LAssert.h"
27 /// This variable keeps a tab on whether the translator was set with the
29 bool translatorsSet = false;
31 /// This is the translator between the Resize enum and corresponding lyx
33 Translator< InsetGraphicsParams::Resize, string >
34 resizeTranslator(InsetGraphicsParams::DEFAULT_SIZE, "default");
36 /// This is the translator between the Origin enum and corresponding lyx
38 Translator< InsetGraphicsParams::Origin, string >
39 originTranslator(InsetGraphicsParams::DEFAULT, "default");
41 /// This is the translator between the Display enum and corresponding lyx
43 Translator< InsetGraphicsParams::DisplayType, string >
44 displayTranslator(InsetGraphicsParams::MONOCHROME, "monochrome");
49 InsetGraphicsParams::InsetGraphicsParams()
54 if (! translatorsSet) {
55 translatorsSet = true;
57 // Fill the resize translator
58 resizeTranslator.addPair(DEFAULT_SIZE, "default");
59 resizeTranslator.addPair(CM, "cm");
60 resizeTranslator.addPair(INCH, "inch");
61 resizeTranslator.addPair(PERCENT_PAGE, "percentOfPage");
62 resizeTranslator.addPair(PERCENT_COLUMN, "percentOfColumn");
64 // Fill the origin translator
65 originTranslator.addPair(DEFAULT, "default");
66 originTranslator.addPair(LEFTTOP, "leftTop");
67 originTranslator.addPair(LEFTCENTER, "leftCenter");
68 originTranslator.addPair(LEFTBASELINE, "leftBaseLine");
69 originTranslator.addPair(LEFTBOTTOM, "leftBottom");
70 originTranslator.addPair(CENTERTOP, "centerTop");
71 originTranslator.addPair(CENTER, "center");
72 originTranslator.addPair(CENTERBASELINE, "centerBaseLine");
73 originTranslator.addPair(CENTERBOTTOM, "centerBottom");
74 originTranslator.addPair(RIGHTTOP, "rightTop");
75 originTranslator.addPair(RIGHTCENTER, "rightCenter");
76 originTranslator.addPair(RIGHTBASELINE, "rightBaseLine");
77 originTranslator.addPair(RIGHTBOTTOM, "rightBottom");
78 originTranslator.addPair(REFERENCE_POINT, "referencePoint");
80 // Fill the display translator
81 displayTranslator.addPair(MONOCHROME, "monochrome");
82 displayTranslator.addPair(GRAYSCALE, "grayscale");
83 displayTranslator.addPair(COLOR, "color");
84 displayTranslator.addPair(NONE, "none");
90 InsetGraphicsParams::InsetGraphicsParams(InsetGraphicsParams const & igp)
92 // I decided to skip the initialization since the copy will overwrite
99 InsetGraphicsParams::operator=(InsetGraphicsParams const & params)
101 // Are we assigning the object into itself?
109 void InsetGraphicsParams::init()
111 subcaptionText = filename = string();
112 display = MONOCHROME;
113 inlineFigure = false;
115 keepAspectRatio = true;
116 widthResize = DEFAULT_SIZE;
118 heightResize = DEFAULT_SIZE;
120 rotateOrigin = DEFAULT;
126 void InsetGraphicsParams::copy(InsetGraphicsParams const & igp)
128 filename = igp.filename;
129 display = igp.display;
130 inlineFigure = igp.inlineFigure;
131 subcaption = igp.subcaption;
132 subcaptionText = igp.subcaptionText;
133 keepAspectRatio = igp.keepAspectRatio;
134 widthResize = igp.widthResize;
135 widthSize = igp.widthSize;
136 heightResize = igp.heightResize;
137 heightSize = igp.heightSize;
138 rotateOrigin = igp.rotateOrigin;
139 rotateAngle = igp.rotateAngle;
144 void InsetGraphicsParams::testInvariant() const
146 // Filename might be empty (when the dialog is first created).
147 // Assert(!filename.empty());
149 Assert(display == COLOR ||
150 display == MONOCHROME ||
151 display == GRAYSCALE ||
155 Assert(widthResize == DEFAULT_SIZE ||
157 widthResize == INCH ||
158 widthResize == PERCENT_PAGE ||
159 widthResize == PERCENT_COLUMN
162 Assert(heightResize == DEFAULT_SIZE ||
163 heightResize == CM ||
164 heightResize == INCH ||
165 heightResize == PERCENT_PAGE
168 Assert(widthSize >= 0.0);
169 Assert(heightSize >= 0.0);
171 // Angle is in degrees and ranges -360 < angle < 360
172 // The reason for this is that in latex there is a meaning for the
173 // different angles and they are not necessarliy interchangeable,
174 // it depends on the rotation origin.
175 Assert(rotateAngle < 360);
176 Assert(rotateAngle > -360);
180 bool operator==(InsetGraphicsParams const & left,
181 InsetGraphicsParams const & right)
183 if (left.filename == right.filename &&
184 left.display == right.display &&
185 left.inlineFigure == right.inlineFigure &&
186 left.subcaption == right.subcaption &&
187 left.subcaptionText == right.subcaptionText &&
188 left.keepAspectRatio == right.keepAspectRatio &&
189 left.widthResize == right.widthResize &&
190 left.widthSize == right.widthSize &&
191 left.heightResize == right.heightResize &&
192 left.heightSize == right.heightSize &&
193 left.rotateOrigin == right.rotateOrigin &&
194 left.rotateAngle == right.rotateAngle
204 void writeResize(ostream & os, string const & key,
205 InsetGraphicsParams::Resize resize, double size)
207 os << ' ' << key << "Resize ";
209 os << resizeTranslator.find(resize);
210 os << ' ' << key << ' ' << size << '\n';
213 void writeOrigin(ostream & os,
214 InsetGraphicsParams::Origin origin)
216 os << " rotateOrigin " << originTranslator.find(origin);
223 void InsetGraphicsParams::Write(Buffer const * buf, ostream & os) const
225 // If there is no filename, write nothing for it.
226 if (! filename.empty()) {
228 << MakeRelPath(filename, OnlyPath(buf->fileName()))
232 // Save the display type
233 os << " display " << displayTranslator.find(display) << '\n';
235 // Save the inline status
239 // Save the subcaption status
243 if (! subcaptionText.empty())
244 os << " subcaptionText \"" << subcaptionText << '\"' << '\n';
246 writeResize(os, "width", widthResize, widthSize);
247 writeResize(os, "height", heightResize, heightSize);
249 writeOrigin(os, rotateOrigin);
250 if (rotateAngle != 0)
251 os << " rotateAngle " << rotateAngle << '\n';
257 void readResize(InsetGraphicsParams * igp, bool height,
258 string const & token)
260 InsetGraphicsParams::Resize resize = InsetGraphicsParams::DEFAULT_SIZE;
262 resize = resizeTranslator.find(token);
265 igp->heightResize = resize;
267 igp->widthResize = resize;
271 void readOrigin(InsetGraphicsParams * igp, string const & token)
273 // TODO: complete this function.
274 igp->rotateOrigin = originTranslator.find(token);
280 bool InsetGraphicsParams::Read(Buffer const * buf, LyXLex & lex,
283 if (token == "filename") {
285 filename = lex.GetString();
287 if (!filename.empty()) {
288 // Make the filename with absolute directory.
289 filename = MakeAbsPath(filename, OnlyPath(buf->fileName()));
291 } else if (token == "display") {
293 string const type = lex.GetString();
295 display = displayTranslator.find(type);
296 } else if (token == "inline") {
298 } else if (token == "subcaption") {
300 } else if (token == "subcaptionText") {
302 subcaptionText = lex.GetString();
303 } else if (token == "widthResize") {
305 string const token = lex.GetString();
307 readResize(this, false, token);
308 } else if (token == "width") {
310 widthSize = lex.GetFloat();
311 } else if (token == "heightResize") {
313 string const token = lex.GetString();
315 readResize(this, true, token);
316 } else if (token == "height") {
318 heightSize = lex.GetFloat();
319 } else if (token == "rotateOrigin") {
321 string const token = lex.GetString();
323 readOrigin(this, token);
324 } else if (token == "rotateAngle") {
326 rotateAngle = lex.GetInteger();
328 // If it's none of the above, its not ours.