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 * ================================================= */
14 #pragma implementation
19 #include "insetgraphicsParams.h"
21 #include "support/translator.h"
22 #include "support/filetools.h"
24 #include "support/LAssert.h"
28 /// This variable keeps a tab on whether the translator was set with the
30 static bool translatorsSet = false;
32 /// This is the translator between the Resize enum and corresponding lyx
34 static Translator<InsetGraphicsParams::Resize, string>
35 resizeTranslator(InsetGraphicsParams::DEFAULT_SIZE, "default");
37 /// This is the translator between the Origin enum and corresponding lyx
39 static Translator<InsetGraphicsParams::Origin, string>
40 originTranslator(InsetGraphicsParams::DEFAULT, "default");
42 /// This is the translator between the Display enum and corresponding lyx
44 static Translator<InsetGraphicsParams::DisplayType, string>
45 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
98 InsetGraphicsParams const &
99 InsetGraphicsParams::operator=(InsetGraphicsParams const ¶ms)
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
201 static void writeResize(ostream & os, char const * key,
202 InsetGraphicsParams::Resize resize, double size)
204 os << ' ' << key << "Resize ";
206 os << resizeTranslator.find(resize);
208 // Old code, before using translators
210 case InsetGraphicsParams::DEFAULT_SIZE:
214 case InsetGraphicsParams::CM:
218 case InsetGraphicsParams::INCH:
222 case InsetGraphicsParams::PERCENT_PAGE:
223 os << "percentOfPage";
226 case InsetGraphicsParams::PERCENT_COLUMN:
227 os << "percentOfColumnt";
231 os << ' ' << key << ' ' << size << endl;
234 static void writeOrigin(ostream & os,
235 InsetGraphicsParams::Origin origin)
237 os << " rotateOrigin " << originTranslator.find(origin);
242 case InsetGraphicsParams:: DEFAULT:
245 case InsetGraphicsParams:: LEFTTOP:
248 case InsetGraphicsParams:: LEFTCENTER:
251 case InsetGraphicsParams:: LEFTBASELINE:
252 os << "LeftBaseLine";
254 case InsetGraphicsParams:: LEFTBOTTOM:
257 case InsetGraphicsParams:: CENTERTOP:
260 case InsetGraphicsParams:: CENTER:
263 case InsetGraphicsParams:: CENTERBASELINE:
264 os << "CenterBaseLine";
266 case InsetGraphicsParams:: CENTERBOTTOM:
267 os << "CenterBottom";
269 case InsetGraphicsParams:: RIGHTTOP:
272 case InsetGraphicsParams:: RIGHTCENTER:
275 case InsetGraphicsParams:: RIGHTBASELINE:
276 os << "RightBaseLine";
278 case InsetGraphicsParams:: RIGHTBOTTOM:
281 // Current REFERENCE_POINT is aliased to LEFTBASELINE
282 // case InsetGraphicsParams:: REFERENCE_POINT:
289 void InsetGraphicsParams::Write(Buffer const * buf, ostream & os) const
291 // If there is no filename, write nothing for it.
292 if (! filename.empty()) {
294 << MakeRelPath(filename, OnlyPath(buf->fileName()))
298 // Save the display type
299 os << " display " << displayTranslator.find(display) << endl;
321 // Save the inline status
325 // Save the subcaption status
329 if (! subcaptionText.empty())
330 os << " subcaptionText \"" << subcaptionText << '\"' << endl;
332 writeResize(os, "width", widthResize, widthSize);
333 writeResize(os, "height", heightResize, heightSize);
335 writeOrigin(os, rotateOrigin);
336 if (rotateAngle != 0)
337 os << " rotateAngle " << rotateAngle << endl;
340 static void readResize(InsetGraphicsParams * igp, bool height,
341 string const & token)
343 InsetGraphicsParams::Resize resize = InsetGraphicsParams::DEFAULT_SIZE;
345 resize = resizeTranslator.find(token);
347 // Old code, before translator.
348 if (token == "default")
349 resize = InsetGraphicsParams::DEFAULT_SIZE;
350 else if (token == "cm")
351 resize = InsetGraphicsParams::CM;
352 else if (token == "inch")
353 resize = InsetGraphicsParams::INCH;
354 else if (token == "percentOfPage")
355 resize = InsetGraphicsParams::PERCENT_PAGE;
356 else if (token == "percentOfColumn")
357 resize = InsetGraphicsParams::PERCENT_COLUMN;
359 lyxerr << "BUG: When reading resize value of InsetGraphicsParam"
360 " unknown token found '" << token << '\'' << endl;
365 igp->heightResize = resize;
367 igp->widthResize = resize;
370 static void readOrigin(InsetGraphicsParams * igp, string const & token)
371 { // TODO: complete this function.
372 igp->rotateOrigin = originTranslator.find(token);
375 bool InsetGraphicsParams::Read(Buffer const * buf, LyXLex & lex,
378 if (token == "filename") {
380 filename = lex.GetString();
382 if (!filename.empty()) {
383 // Make the filename with absolute directory.
384 filename = MakeAbsPath(filename, OnlyPath(buf->fileName()));
386 } else if (token == "display") {
388 string const type = lex.GetString();
390 display = displayTranslator.find(type);
394 else if (type == "grayscale")
396 else if (type == "monochrome")
397 display = MONOCHROME;
398 else if (type == "none")
401 display = MONOCHROME;
402 lyxerr << "BUG: When reading InsetGraphicsParams"
403 " display has an unknown type " << type << endl;
406 } else if (token == "inline") {
408 } else if (token == "subcaption") {
410 } else if (token == "subcaptionText") {
412 subcaptionText = lex.GetString();
413 } else if (token == "widthResize") {
415 string const token = lex.GetString();
417 readResize(this, false, token);
418 } else if (token == "width") {
420 widthSize = lex.GetFloat();
421 } else if (token == "heightResize") {
423 string const token = lex.GetString();
425 readResize(this, true, token);
426 } else if (token == "height") {
428 heightSize = lex.GetFloat();
429 } else if (token == "rotateOrigin") {
431 string const token = lex.GetString();
433 readOrigin(this, token);
434 } else if (token == "rotateAngle") {
436 rotateAngle = lex.GetInteger();
438 // If it's none of the above, its not ours.