src/insets/InsetGraphicsParams.cpp

   1 /**
   2  * \file InsetGraphicsParams.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Baruch Even
   7  * \author Herbert Voß
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetGraphicsParams.h"
  15
  16 #include "Buffer.h"
  17 #include "LyX.h" // for use_gui
  18 #include "Lexer.h"
  19 #include "LyXRC.h"
  20
  21 #include "graphics/epstools.h"
  22 #include "graphics/GraphicsParams.h"
  23 #include "graphics/GraphicsTypes.h"
  24
  25 #include "support/convert.h"
  26 #include "support/debug.h"
  27 #include "support/lyxlib.h"
  28 #include "support/lstrings.h"
  29 #include "support/Translator.h"
  30
  31 #include <ostream>
  32
  33 using namespace std;
  34 using namespace lyx::support;
  35
  36 namespace lyx {
  37
  38
  39 InsetGraphicsParams::InsetGraphicsParams()
  40 {
  41         init();
  42 }
  43
  44
  45 InsetGraphicsParams::InsetGraphicsParams(InsetGraphicsParams const & igp)
  46 {
  47         // I decided to skip the initialization since the copy will overwrite
  48         // everything anyway.
  49         //    init();
  50         copy(igp);
  51 }
  52
  53
  54 void InsetGraphicsParams::operator=(InsetGraphicsParams const & params)
  55 {
  56         // Are we assigning the object into itself?
  57         if (this == &params)
  58                 return;
  59         copy(params);
  60 }
  61
  62
  63 void InsetGraphicsParams::init()
  64 {
  65         filename.erase();
  66         lyxscale = 100;                 // lyx scaling in percentage
  67         display = true;         // may be overriden by display mode in preferences
  68         scale = string("100");                  // output scaling in percentage
  69         width = Length();
  70         height = Length();
  71         keepAspectRatio = false;        // for LaTeX output
  72         draft = false;                  // draft mode
  73         scaleBeforeRotation = false;    // scale image before rotating
  74
  75         bb = string();                  // bounding box
  76         clip = false;                   // clip image
  77
  78         rotateAngle = "0";              // angle of rotation in degrees
  79         rotateOrigin.erase();           // Origin of rotation
  80         special.erase();                // additional userdefined stuff
  81         groupId.clear();
  82 }
  83
  84
  85 void InsetGraphicsParams::copy(InsetGraphicsParams const & igp)
  86 {
  87         filename = igp.filename;
  88         lyxscale = igp.lyxscale;
  89         display = igp.display;
  90         scale = igp.scale;
  91         width = igp.width;
  92         height = igp.height;
  93         keepAspectRatio = igp.keepAspectRatio;
  94         draft = igp.draft;
  95         scaleBeforeRotation = igp.scaleBeforeRotation;
  96
  97         bb = igp.bb;
  98         clip = igp.clip;
  99
 100         rotateAngle = igp.rotateAngle;
 101         rotateOrigin = igp.rotateOrigin;
 102         special = igp.special;
 103         groupId = igp.groupId;
 104 }
 105
 106
 107 bool operator==(InsetGraphicsParams const & left,
 108                 InsetGraphicsParams const & right)
 109 {
 110         return left.filename == right.filename &&
 111             left.lyxscale == right.lyxscale &&
 112             left.display == right.display &&
 113             left.scale == right.scale &&
 114             left.width == right.width &&
 115             left.height == right.height &&
 116             left.keepAspectRatio == right.keepAspectRatio &&
 117             left.draft == right.draft &&
 118             left.scaleBeforeRotation == right.scaleBeforeRotation &&
 119
 120             left.bb == right.bb &&
 121             left.clip == right.clip &&
 122
 123             left.rotateAngle == right.rotateAngle &&
 124             left.rotateOrigin == right.rotateOrigin &&
 125             left.special == right.special &&
 126             left.groupId == right.groupId;
 127 }
 128
 129
 130 bool operator!=(InsetGraphicsParams const & left,
 131                 InsetGraphicsParams const & right)
 132 {
 133         return  !(left == right);
 134 }
 135
 136
 137 void InsetGraphicsParams::Write(ostream & os, Buffer const & buffer) const
 138 {
 139         // Do not write the default values
 140         if (!filename.empty())
 141                 os << "\tfilename " << filename.outputFileName(buffer.filePath()) << '\n';
 142         if (lyxscale != 100)
 143                 os << "\tlyxscale " << lyxscale << '\n';
 144         if (!display)
 145                 os << "\tdisplay false\n";
 146         if (!scale.empty() && !float_equal(convert<double>(scale), 0.0, 0.05)) {
 147                 if (!float_equal(convert<double>(scale), 100.0, 0.05))
 148                         os << "\tscale " << scale << '\n';
 149         } else {
 150                 if (!width.zero())
 151                         os << "\twidth " << width.asString() << '\n';
 152                 if (!height.zero())
 153                         os << "\theight " << height.asString() << '\n';
 154         }
 155
 156         if (keepAspectRatio)
 157                 os << "\tkeepAspectRatio\n";
 158         if (draft)                      // draft mode
 159                 os << "\tdraft\n";
 160         if (scaleBeforeRotation)
 161                 os << "\tscaleBeforeRotation\n";
 162
 163         if (!bb.empty())                // bounding box
 164                 os << "\tBoundingBox " << bb << '\n';
 165         if (clip)                       // clip image
 166                 os << "\tclip\n";
 167
 168         if (!rotateAngle.empty()
 169                 && !float_equal(convert<double>(rotateAngle), 0.0, 0.001))
 170                 os << "\trotateAngle " << rotateAngle << '\n';
 171         if (!rotateOrigin.empty())
 172                 os << "\trotateOrigin " << rotateOrigin << '\n';
 173         if (!special.empty())
 174                 os << "\tspecial " << special << '\n';
 175         if (!groupId.empty())
 176                 os << "\tgroupId "<< groupId << '\n';
 177 }
 178
 179
 180 bool InsetGraphicsParams::Read(Lexer & lex, string const & token, string const & bufpath)
 181 {
 182         if (token == "filename") {
 183                 lex.eatLine();
 184                 filename.set(lex.getString(), bufpath);
 185         } else if (token == "lyxscale") {
 186                 lex.next();
 187                 lyxscale = lex.getInteger();
 188         } else if (token == "display") {
 189                 lex.next();
 190                 string const type = lex.getString();
 191                 display = lex.getString() != "false";
 192         } else if (token == "scale") {
 193                 lex.next();
 194                 scale = lex.getString();
 195         } else if (token == "width") {
 196                 lex.next();
 197                 width = Length(lex.getString());
 198                 scale = string();
 199         } else if (token == "height") {
 200                 lex.next();
 201                 height = Length(lex.getString());
 202                 scale = string();
 203         } else if (token == "keepAspectRatio") {
 204                 keepAspectRatio = true;
 205         } else if (token == "draft") {
 206                 draft = true;
 207         } else if (token == "scaleBeforeRotation") {
 208                 scaleBeforeRotation = true;
 209         } else if (token == "BoundingBox") {
 210                 bb.erase();
 211                 for (int i = 0; i < 4; ++i) {
 212                         if (i != 0)
 213                                 bb += ' ';
 214                         lex.next();
 215                         bb += lex.getString();
 216                 }
 217         } else if (token == "clip") {
 218                 clip = true;
 219         } else if (token == "rotateAngle") {
 220                 lex.next();
 221                 rotateAngle = lex.getString();
 222         } else if (token == "rotateOrigin") {
 223                 lex.next();
 224                 rotateOrigin=lex.getString();
 225         } else if (token == "special") {
 226                 lex.eatLine();
 227                 special = lex.getString();
 228         } else if (token == "groupId") {
 229                 lex.eatLine();
 230                 groupId = lex.getString();
 231
 232         // catch and ignore following two old-format tokens and their arguments.
 233         // e.g. "size_kind scale" clashes with the setting of the
 234         // "scale <value>" keyword.
 235         } else if (token == "size_kind" || token == "lyxsize_kind") {
 236                 lex.next();
 237                 lex.getString();
 238
 239         } else {
 240                 // If it's none of the above, it's not ours.
 241                 return false;
 242         }
 243         return true;
 244 }
 245
 246
 247 graphics::Params InsetGraphicsParams::as_grfxParams() const
 248 {
 249         graphics::Params pars;
 250         pars.filename = filename;
 251         pars.scale = lyxscale;
 252         pars.angle = convert<double>(rotateAngle);
 253
 254         if (clip) {
 255                 pars.bb = bb;
 256
 257                 // Get the original Bounding Box from the file
 258                 string const tmp = graphics::readBB_from_PSFile(filename);
 259                 LYXERR(Debug::GRAPHICS, "BB_from_File: " << tmp);
 260                 if (!tmp.empty()) {
 261                         unsigned int const bb_orig_xl = convert<unsigned int>(token(tmp, ' ', 0));
 262                         unsigned int const bb_orig_yb = convert<unsigned int>(token(tmp, ' ', 1));
 263
 264                         // new pars.bb values must be >= zero
 265                         if (pars.bb.xl > bb_orig_xl)
 266                                 pars.bb.xl -= bb_orig_xl;
 267                         else
 268                                 pars.bb.xl = 0;
 269
 270                         if (pars.bb.xr > bb_orig_xl)
 271                                 pars.bb.xr -= bb_orig_xl;
 272                         else
 273                                 pars.bb.xr = 0;
 274
 275                         if (pars.bb.yb > bb_orig_yb)
 276                                 pars.bb.yb -= bb_orig_yb;
 277                         else
 278                                 pars.bb.yb = 0;
 279
 280                         if (pars.bb.yt > bb_orig_yb)
 281                                 pars.bb.yt -= bb_orig_yb;
 282                         else
 283                                 pars.bb.yt = 0;
 284                 }
 285
 286                 // Paranoia check.
 287                 int const width  = pars.bb.xr - pars.bb.xl;
 288                 int const height = pars.bb.yt - pars.bb.yb;
 289
 290                 if (width  < 0 || height < 0) {
 291                         pars.bb.xl = 0;
 292                         pars.bb.xr = 0;
 293                         pars.bb.yb = 0;
 294                         pars.bb.yt = 0;
 295                 }
 296         }
 297
 298         pars.display = display;
 299
 300         // Override the above if we're not using a gui
 301         if (!use_gui)
 302                 pars.display = false;
 303
 304         return pars;
 305 }
 306
 307
 308 } // namespace lyx