1 /* This file is part of
2 * =================================================
4 * LyX, The Document Processor
5 * Copyright 1995 Matthias Ettrich.
6 * Copyright 1995-2001 The LyX Team.
8 * This file Copyright 2000 Baruch Even
9 * ================================================= */
14 #pragma implementation
17 #include "insetgraphicsParams.h"
19 #include "support/translator.h"
20 #include "support/filetools.h"
22 #include "support/LAssert.h"
26 /// This variable keeps a tab on whether the translator was set with the
28 bool translatorsSet = false;
30 /// This is the translator between the Resize enum and corresponding lyx
32 Translator< InsetGraphicsParams::Resize, string >
33 resizeTranslator(InsetGraphicsParams::DEFAULT_SIZE, "default");
35 /// This is the translator between the Origin enum and corresponding lyx
37 Translator< InsetGraphicsParams::Origin, string >
38 originTranslator(InsetGraphicsParams::DEFAULT, "default");
40 /// This is the translator between the Display enum and corresponding lyx
42 Translator< InsetGraphicsParams::DisplayType, string >
43 displayTranslator(InsetGraphicsParams::MONOCHROME, "monochrome");
48 InsetGraphicsParams::InsetGraphicsParams()
53 if (! translatorsSet) {
54 translatorsSet = true;
56 // Fill the resize translator
57 resizeTranslator.addPair(DEFAULT_SIZE, "default");
58 resizeTranslator.addPair(CM, "cm");
59 resizeTranslator.addPair(INCH, "inch");
60 resizeTranslator.addPair(PERCENT_PAGE, "percentOfPage");
61 resizeTranslator.addPair(PERCENT_COLUMN, "percentOfColumn");
63 // Fill the origin translator
64 originTranslator.addPair(DEFAULT, "default");
65 originTranslator.addPair(LEFTTOP, "leftTop");
66 originTranslator.addPair(LEFTCENTER, "leftCenter");
67 originTranslator.addPair(LEFTBASELINE, "leftBaseLine");
68 originTranslator.addPair(LEFTBOTTOM, "leftBottom");
69 originTranslator.addPair(CENTERTOP, "centerTop");
70 originTranslator.addPair(CENTER, "center");
71 originTranslator.addPair(CENTERBASELINE, "centerBaseLine");
72 originTranslator.addPair(CENTERBOTTOM, "centerBottom");
73 originTranslator.addPair(RIGHTTOP, "rightTop");
74 originTranslator.addPair(RIGHTCENTER, "rightCenter");
75 originTranslator.addPair(RIGHTBASELINE, "rightBaseLine");
76 originTranslator.addPair(RIGHTBOTTOM, "rightBottom");
77 originTranslator.addPair(REFERENCE_POINT, "referencePoint");
79 // Fill the display translator
80 displayTranslator.addPair(MONOCHROME, "monochrome");
81 displayTranslator.addPair(GRAYSCALE, "grayscale");
82 displayTranslator.addPair(COLOR, "color");
83 displayTranslator.addPair(NONE, "none");
89 InsetGraphicsParams::InsetGraphicsParams(InsetGraphicsParams const & igp)
91 // I decided to skip the initialization since the copy will overwrite
98 InsetGraphicsParams::operator=(InsetGraphicsParams const & params)
100 // Are we assigning the object into itself?
108 void InsetGraphicsParams::init()
110 subcaptionText = filename = string();
111 display = MONOCHROME;
112 inlineFigure = false;
114 keepAspectRatio = true;
115 widthResize = DEFAULT_SIZE;
117 heightResize = DEFAULT_SIZE;
119 rotateOrigin = DEFAULT;
125 void InsetGraphicsParams::copy(InsetGraphicsParams const & igp)
127 filename = igp.filename;
128 display = igp.display;
129 inlineFigure = igp.inlineFigure;
130 subcaption = igp.subcaption;
131 subcaptionText = igp.subcaptionText;
132 keepAspectRatio = igp.keepAspectRatio;
133 widthResize = igp.widthResize;
134 widthSize = igp.widthSize;
135 heightResize = igp.heightResize;
136 heightSize = igp.heightSize;
137 rotateOrigin = igp.rotateOrigin;
138 rotateAngle = igp.rotateAngle;
143 void InsetGraphicsParams::testInvariant() const
145 // Filename might be empty (when the dialog is first created).
146 // Assert(!filename.empty());
148 lyx::Assert(display == COLOR ||
149 display == MONOCHROME ||
150 display == GRAYSCALE ||
154 lyx::Assert(widthResize == DEFAULT_SIZE ||
156 widthResize == INCH ||
157 widthResize == PERCENT_PAGE ||
158 widthResize == PERCENT_COLUMN
161 lyx::Assert(heightResize == DEFAULT_SIZE ||
162 heightResize == CM ||
163 heightResize == INCH ||
164 heightResize == PERCENT_PAGE
167 lyx::Assert(widthSize >= 0.0);
168 lyx::Assert(heightSize >= 0.0);
170 // Angle is in degrees and ranges -360 < angle < 360
171 // The reason for this is that in latex there is a meaning for the
172 // different angles and they are not necessarliy interchangeable,
173 // it depends on the rotation origin.
174 lyx::Assert(rotateAngle < 360);
175 lyx::Assert(rotateAngle > -360);
179 bool operator==(InsetGraphicsParams const & left,
180 InsetGraphicsParams const & right)
182 if (left.filename == right.filename &&
183 left.display == right.display &&
184 left.inlineFigure == right.inlineFigure &&
185 left.subcaption == right.subcaption &&
186 left.subcaptionText == right.subcaptionText &&
187 left.keepAspectRatio == right.keepAspectRatio &&
188 left.widthResize == right.widthResize &&
189 left.widthSize == right.widthSize &&
190 left.heightResize == right.heightResize &&
191 left.heightSize == right.heightSize &&
192 left.rotateOrigin == right.rotateOrigin &&
193 left.rotateAngle == right.rotateAngle
200 bool operator!=(InsetGraphicsParams const & left,
201 InsetGraphicsParams const & right)
203 return !(left == right);
209 void writeResize(ostream & os, string const & key,
210 InsetGraphicsParams::Resize resize, double size)
212 os << ' ' << key << "Resize ";
214 os << resizeTranslator.find(resize);
215 os << ' ' << key << ' ' << size << '\n';
218 void writeOrigin(ostream & os,
219 InsetGraphicsParams::Origin origin)
221 os << " rotateOrigin " << originTranslator.find(origin);
228 void InsetGraphicsParams::Write(Buffer const * buf, ostream & os) const
230 // If there is no filename, write nothing for it.
231 if (! filename.empty()) {
233 << MakeRelPath(filename, OnlyPath(buf->fileName()))
237 // Save the display type
238 os << " display " << displayTranslator.find(display) << '\n';
240 // Save the inline status
244 // Save the subcaption status
248 if (! subcaptionText.empty())
249 os << " subcaptionText \"" << subcaptionText << '\"' << '\n';
251 writeResize(os, "width", widthResize, widthSize);
252 writeResize(os, "height", heightResize, heightSize);
254 writeOrigin(os, rotateOrigin);
255 if (rotateAngle != 0)
256 os << " rotateAngle " << rotateAngle << '\n';
262 void readResize(InsetGraphicsParams * igp, bool height,
263 string const & token)
265 InsetGraphicsParams::Resize resize = InsetGraphicsParams::DEFAULT_SIZE;
267 resize = resizeTranslator.find(token);
270 igp->heightResize = resize;
272 igp->widthResize = resize;
276 void readOrigin(InsetGraphicsParams * igp, string const & token)
278 // TODO: complete this function.
279 igp->rotateOrigin = originTranslator.find(token);
285 bool InsetGraphicsParams::Read(Buffer const * buf, LyXLex & lex,
288 if (token == "filename") {
290 filename = lex.GetString();
292 if (!filename.empty()) {
293 // Make the filename with absolute directory.
294 filename = MakeAbsPath(filename, OnlyPath(buf->fileName()));
296 } else if (token == "display") {
298 string const type = lex.GetString();
300 display = displayTranslator.find(type);
301 } else if (token == "inline") {
303 } else if (token == "subcaption") {
305 } else if (token == "subcaptionText") {
307 subcaptionText = lex.GetString();
308 } else if (token == "widthResize") {
310 string const token = lex.GetString();
312 readResize(this, false, token);
313 } else if (token == "width") {
315 widthSize = lex.GetFloat();
316 } else if (token == "heightResize") {
318 string const token = lex.GetString();
320 readResize(this, true, token);
321 } else if (token == "height") {
323 heightSize = lex.GetFloat();
324 } else if (token == "rotateOrigin") {
326 string const token = lex.GetString();
328 readOrigin(this, token);
329 } else if (token == "rotateAngle") {
331 rotateAngle = lex.GetInteger();
333 // If it's none of the above, its not ours.