]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetgraphicsParams.C
move inset related stuff from src/graphics to src/inset/
[lyx.git] / src / insets / insetgraphicsParams.C
index 83956d378aa23e4c84c7e9b99729a138e6c3ce87..41c61fdb7851eb9e8a4c8b045e1da5d8246feecd 100644 (file)
@@ -1,18 +1,20 @@
 /* This file is part of
  * =================================================
- * 
+ *
  *          LyX, The Document Processor
  *          Copyright 1995 Matthias Ettrich.
  *          Copyright 1995-2001 The LyX Team.
  *
- *          This file Copyright 2000 Baruch Even
+ * \author Baruch Even
+ * \author Herbert Voss <voss@lyx.org>
+ *
  * ================================================= */
 
-#include <config.h> 
+#include <config.h>
 
 #ifdef __GNUG__
 #pragma implementation
-#endif 
+#endif
 
 #include "insetgraphicsParams.h"
 
 #include "support/filetools.h"
 #include "support/lyxlib.h"
 #include "support/LOstream.h"
-
 #include "support/LAssert.h"
+#include "support/lstrings.h"
+#include "lyxrc.h"
+#include "debug.h"
+
+
+using std::ostream;
+
 
 namespace {
 
@@ -29,20 +37,10 @@ namespace {
 /// translations.
 bool translatorsSet = false;
 
-/// This is the translator between the Resize enum and corresponding lyx
-/// file strings.
-Translator< InsetGraphicsParams::Resize, string >
-resizeTranslator(InsetGraphicsParams::DEFAULT_SIZE, "default");
-
-/// This is the translator between the Origin enum and corresponding lyx
-/// file strings.
-Translator< InsetGraphicsParams::Origin, string >
-originTranslator(InsetGraphicsParams::DEFAULT, "default");
-
 /// This is the translator between the Display enum and corresponding lyx
 /// file strings.
 Translator< InsetGraphicsParams::DisplayType, string >
-displayTranslator(InsetGraphicsParams::MONOCHROME, "monochrome");
+displayTranslator(InsetGraphicsParams::DEFAULT, "default");
 
 } // namespace anon
 
@@ -50,42 +48,16 @@ displayTranslator(InsetGraphicsParams::MONOCHROME, "monochrome");
 InsetGraphicsParams::InsetGraphicsParams()
 {
        init();
-
        // Set translators
        if (! translatorsSet) {
                translatorsSet = true;
-
-               // Fill the resize translator
-               resizeTranslator.addPair(DEFAULT_SIZE, "default");
-               resizeTranslator.addPair(CM, "cm");
-               resizeTranslator.addPair(INCH, "inch");
-               resizeTranslator.addPair(PERCENT_PAGE, "percentOfPage");
-               resizeTranslator.addPair(PERCENT_COLUMN, "percentOfColumn");
-               resizeTranslator.addPair(SCALE, "scale");
-
-               // Fill the origin translator
-               originTranslator.addPair(DEFAULT, "default");
-               originTranslator.addPair(LEFTTOP, "leftTop");
-               originTranslator.addPair(LEFTCENTER, "leftCenter");
-               originTranslator.addPair(LEFTBASELINE, "leftBaseLine");
-               originTranslator.addPair(LEFTBOTTOM, "leftBottom");
-               originTranslator.addPair(CENTERTOP, "centerTop");
-               originTranslator.addPair(CENTER, "center");
-               originTranslator.addPair(CENTERBASELINE, "centerBaseLine");
-               originTranslator.addPair(CENTERBOTTOM, "centerBottom");
-               originTranslator.addPair(RIGHTTOP, "rightTop");
-               originTranslator.addPair(RIGHTCENTER, "rightCenter");
-               originTranslator.addPair(RIGHTBASELINE, "rightBaseLine");
-               originTranslator.addPair(RIGHTBOTTOM, "rightBottom");
-               originTranslator.addPair(REFERENCE_POINT, "referencePoint");
-
                // Fill the display translator
+               displayTranslator.addPair(DEFAULT, "default");
                displayTranslator.addPair(MONOCHROME, "monochrome");
                displayTranslator.addPair(GRAYSCALE, "grayscale");
                displayTranslator.addPair(COLOR, "color");
                displayTranslator.addPair(NONE, "none");
        }
-
 }
 
 
@@ -103,7 +75,6 @@ InsetGraphicsParams::operator=(InsetGraphicsParams const & params)
        // Are we assigning the object into itself?
        if (this == &params)
                return * this;
-
        copy(params);
        return *this;
 }
@@ -111,225 +82,323 @@ InsetGraphicsParams::operator=(InsetGraphicsParams const & params)
 void InsetGraphicsParams::init()
 {
        subcaptionText = filename = string();
-       display = MONOCHROME;
-       subcaption = false;
-       keepAspectRatio = true;
-       widthResize = DEFAULT_SIZE;
-       widthSize = 0.0;
-       heightResize = DEFAULT_SIZE;
-       heightSize = 0.0;
-       rotateOrigin = DEFAULT;
-       rotateAngle = 0.0;
-
-       testInvariant();
+       bb = string();                  // bounding box
+       draft = false;                  // draft mode
+       clip = false;                   // clip image
+       display = DEFAULT;              // see pref
+       subcaption = false;             // subfigure
+       noUnzip = false;                // unzip files
+       width = LyXLength();            // set to 0pt
+       height = LyXLength();
+       lyxwidth = LyXLength();         // for the view in lyx
+       lyxheight = LyXLength();        // also set to 0pt
+       scale = 0;                      // unit is %
+       lyxscale = 0;                   // same for lyxview
+       size_type = DEFAULT_SIZE;       // do nothing
+       lyxsize_type = DEFAULT_SIZE;    // do nothing
+       keepAspectRatio = false;        // only for latex
+       rotate = false;                 // Rotating
+       rotateOrigin = "center";        // Origin
+       rotateAngle = 0.0;              // in degrees
+       special = string();             // userdefined stuff
 }
 
 void InsetGraphicsParams::copy(InsetGraphicsParams const & igp)
 {
        filename = igp.filename;
+       bb = igp.bb;
+       draft = igp.draft;
+       clip = igp.clip;
        display = igp.display;
        subcaption = igp.subcaption;
        subcaptionText = igp.subcaptionText;
+       noUnzip = igp.noUnzip;
        keepAspectRatio = igp.keepAspectRatio;
-       widthResize = igp.widthResize;
-       widthSize = igp.widthSize;
-       heightResize = igp.heightResize;
-       heightSize = igp.heightSize;
+       width = igp.width;
+       height = igp.height;
+       scale = igp.scale;
+       size_type = igp.size_type;
+       lyxsize_type = igp.lyxsize_type;
+       lyxwidth = igp.lyxwidth;
+       lyxheight = igp.lyxheight;
+       lyxscale = igp.lyxscale;
+       rotate = igp.rotate;
        rotateOrigin = igp.rotateOrigin;
        rotateAngle = igp.rotateAngle;
-
-       testInvariant();
-}
-
-void InsetGraphicsParams::testInvariant() const
-{
-       // Filename might be empty (when the dialog is first created).
-       // Assert(!filename.empty());
-
-       lyx::Assert(display == COLOR ||
-              display == MONOCHROME ||
-              display == GRAYSCALE ||
-              display == NONE
-             );
-
-       lyx::Assert(widthResize == DEFAULT_SIZE ||
-              widthResize == CM ||
-              widthResize == INCH ||
-              widthResize == PERCENT_PAGE ||
-              widthResize == PERCENT_COLUMN ||
-                  widthResize == SCALE
-             );
-
-       lyx::Assert(heightResize == DEFAULT_SIZE ||
-              heightResize == CM ||
-              heightResize == INCH ||
-              heightResize == PERCENT_PAGE ||
-                  heightResize == SCALE
-             );
-
-       // For SCALE these can be negative.
-       //lyx::Assert(widthSize >= 0.0);
-       //lyx::Assert(heightSize >= 0.0);
-
-       // Angle is in degrees and ranges -360 < angle < 360
-       // The reason for this is that in latex there is a meaning for the
-       // different angles and they are not necessarliy interchangeable,
-       // it depends on the rotation origin.
-       lyx::Assert(rotateAngle < 360.0);
-       lyx::Assert(rotateAngle > -360.0);
-
+       special = igp.special;
 }
 
 bool operator==(InsetGraphicsParams const & left,
-                InsetGraphicsParams const & right)
+               InsetGraphicsParams const & right)
 {
        if (left.filename == right.filename &&
-               left.display == right.display &&
-               left.subcaption == right.subcaption &&
-               left.subcaptionText == right.subcaptionText &&
-               left.keepAspectRatio == right.keepAspectRatio &&
-               left.widthResize == right.widthResize &&
-               left.widthSize == right.widthSize &&
-               left.heightResize == right.heightResize &&
-               left.heightSize == right.heightSize &&
-               left.rotateOrigin == right.rotateOrigin &&
-               lyx::float_equal(left.rotateAngle, right.rotateAngle, 0.001)
-          )
+           left.bb == right.bb &&
+           left.draft == right.draft &&
+           left.clip == right.clip &&
+           left.display == right.display &&
+           left.subcaption == right.subcaption &&
+           left.noUnzip == right.noUnzip &&
+           left.subcaptionText == right.subcaptionText &&
+           left.keepAspectRatio == right.keepAspectRatio &&
+           left.width == right.width &&
+           left.height == right.height &&
+           left.scale == right.scale &&
+           left.size_type == right.size_type &&
+           left.lyxsize_type == right.lyxsize_type &&
+           left.lyxwidth == right.lyxwidth &&
+           left.lyxheight == right.lyxheight &&
+           left.lyxscale == right.lyxscale &&
+           left.rotate == right.rotate &&
+           left.rotateOrigin == right.rotateOrigin &&
+           lyx::float_equal(left.rotateAngle, right.rotateAngle, 0.001 &&
+                            left.special == right.special)
+               )
                return true;
 
        return false;
 }
 
 bool operator!=(InsetGraphicsParams const & left,
-                InsetGraphicsParams const & right)
+               InsetGraphicsParams const & right)
 {
-       return  !(left == right);
+       return  !(left == right);
 }
 
 
-namespace {
-
-void writeResize(ostream & os, string const & key,
-                        InsetGraphicsParams::Resize resize, double size)
-{
-       os << ' ' << key << "Resize ";
-
-       os << resizeTranslator.find(resize);
-       os << ' ' << key << ' ' << size << '\n';
-}
-
-void writeOrigin(ostream & os,
-                        InsetGraphicsParams::Origin origin)
-{
-       os << " rotateOrigin " << originTranslator.find(origin);
-       os << '\n';
-}
-
-} // namespace anon
-
-
-void InsetGraphicsParams::Write(Buffer const * buf, ostream & os) const
+void InsetGraphicsParams::Write(ostream & os) const
 {
        // If there is no filename, write nothing for it.
-       if (! filename.empty()) {
-               os << "filename "
-               << MakeRelPath(filename, OnlyPath(buf->fileName()))
-               << '\n';
+       if (!filename.empty()) {
+               os << "\tfilename " << filename << '\n';
        }
-
-       // Save the display type
-       os << " display " << displayTranslator.find(display) << '\n';
-
+       if (!bb.empty())                // bounding box
+               os << "\tBoundingBox " << bb << '\n';
+       if (clip)                       // clip image
+               os << "\tclip\n";
+       if (draft)                      // draft mode
+               os << "\tdraft\n";
+       // Save the display type for the view inside lyx
+       os << "\tdisplay " << displayTranslator.find(display) << '\n';
        // Save the subcaption status
        if (subcaption)
-               os << " subcaption";
-
-       if (! subcaptionText.empty())
-               os << " subcaptionText \"" << subcaptionText << '\"' << '\n';
-
-       writeResize(os, "width", widthResize, widthSize);
-       writeResize(os, "height", heightResize, heightSize);
-
-       writeOrigin(os, rotateOrigin);
-       if (lyx::float_equal(rotateAngle, 0.0, 0.001))
-               os << " rotateAngle " << rotateAngle << '\n';
-}
-
-
-namespace {
-
-void readResize(InsetGraphicsParams * igp, bool height,
-                       string const & token)
-{
-       InsetGraphicsParams::Resize resize = InsetGraphicsParams::DEFAULT_SIZE;
-
-       resize = resizeTranslator.find(token);
-
-       if (height)
-               igp->heightResize = resize;
-       else
-               igp->widthResize = resize;
-}
-
-
-void readOrigin(InsetGraphicsParams * igp, string const & token)
-{
-       // TODO: complete this function.
-       igp->rotateOrigin = originTranslator.find(token);
+               os << "\tsubcaption\n";
+       if (!subcaptionText.empty())
+               os << "\tsubcaptionText \"" << subcaptionText << '\"' << '\n';
+       if (noUnzip)
+               os << "\tnoUnzip\n";
+       // we always need the size type
+       // 0: no special
+       // 1: width/height combination
+       // 2: scale
+       os << "\tsize_type " <<  size_type << '\n';
+       if (!width.zero())
+               os << "\twidth " << width.asString() << '\n';
+       if (!height.zero())
+               os << "\theight " << height.asString() << '\n';
+       if (scale != 0)
+               os << "\tscale " << scale << '\n';
+       if (keepAspectRatio)
+               os << "\tkeepAspectRatio\n";
+       if (rotate)
+               os << "\trotate\n";
+       if (rotateAngle != 0.0)
+               os << "\trotateAngle " << rotateAngle << '\n';
+       if (!rotateOrigin.empty())
+               os << "\trotateOrigin " << rotateOrigin << '\n';
+       if (!special.empty())
+               os << "\tspecial " << special << '\n';
+       // the values for the view in lyx
+       os << "\tlyxsize_type " <<  lyxsize_type << '\n';
+       if (!lyxwidth.zero())           // the lyx-viewsize
+               os << "\tlyxwidth " << lyxwidth.asString() << '\n';
+       if (!lyxheight.zero())
+               os << "\tlyxheight " << lyxheight.asString();
+       if (lyxscale != 0)
+               os << "\tlyxscale " << lyxscale << '\n';
 }
 
-} // namespace anon
-
 
-bool InsetGraphicsParams::Read(Buffer const * buf, LyXLex & lex,
-                               string const& token)
+bool InsetGraphicsParams::Read(LyXLex & lex, string const & token)
 {
        if (token == "filename") {
                lex.next();
                filename = lex.getString();
-
-               if (!filename.empty()) {
-                       // Make the filename with absolute directory.
-                       filename = MakeAbsPath(filename, OnlyPath(buf->fileName()));
+       } else if (token == "BoundingBox") {
+               for (int i=0; i<4 ;i++) {
+                       lex.next();
+                       bb += (lex.getString()+" ");
                }
+       } else if (token == "clip") {
+               clip = true;
+       } else if (token == "draft") {
+               draft = true;
        } else if (token == "display") {
                lex.next();
                string const type = lex.getString();
-
                display = displayTranslator.find(type);
        } else if (token == "subcaption") {
                subcaption = true;
        } else if (token == "subcaptionText") {
                lex.next();
                subcaptionText = lex.getString();
-       } else if (token == "widthResize") {
+       } else if (token == "noUnzip") {
+               noUnzip = true;
+       } else if (token == "size_type") {
                lex.next();
-               string const token = lex.getString();
-
-               readResize(this, false, token);
+               switch (lex.getInteger()) {
+               case 0:
+                       size_type = DEFAULT_SIZE;
+                       break;
+               case 1:
+                       size_type = WH;
+                       break;
+               case 2:
+                       size_type = SCALE;
+                       break;
+               }
        } else if (token == "width") {
                lex.next();
-               widthSize = lex.getFloat();
-       } else if (token == "heightResize") {
-               lex.next();
-               string const token = lex.getString();
-
-               readResize(this, true, token);
+               width = LyXLength(lex.getString());
        } else if (token == "height") {
                lex.next();
-               heightSize = lex.getFloat();
-       } else if (token == "rotateOrigin") {
+               height = LyXLength(lex.getString());
+       } else if (token == "keepAspectRatio") {
+               keepAspectRatio = true;
+       } else if (token == "scale") {
                lex.next();
-               string const token = lex.getString();
-
-               readOrigin(this, token);
+               scale = lex.getInteger();
+       } else if (token == "rotate") {
+               rotate = true;
        } else if (token == "rotateAngle") {
                lex.next();
                rotateAngle = lex.getFloat();
-       } else {
-               // If it's none of the above, its not ours.
+       } else if (token == "rotateOrigin") {
+               lex.next();
+               rotateOrigin=lex.getString();
+       } else if (token == "lyxsize_type") {
+               lex.next();
+               switch (lex.getInteger()) {
+               case 0:
+                       lyxsize_type = DEFAULT_SIZE;
+                       break;
+               case 1:
+                       lyxsize_type = WH;
+                       break;
+               case 2:
+                       lyxsize_type = SCALE;
+                       break;
+               }
+       } else if (token == "lyxwidth") {
+               lex.next();
+               lyxwidth = LyXLength(lex.getString());
+       } else if (token == "lyxheight") {
+               lex.next();
+               lyxheight = LyXLength(lex.getString());
+       } else if (token == "lyxscale") {
+               lex.next();
+               lyxscale = lex.getInteger();
+       } else if (token == "special") {
+               lex.eatLine();
+               special = lex.getString();
+       } else {        // If it's none of the above, its not ours.
                return false;
        }
-
        return true;
 }
+
+
+grfx::GParams InsetGraphicsParams::asGParams(string const & filepath) const
+{
+       grfx::GParams pars;
+       pars.width    = 0;
+       pars.height   = 0;
+       pars.scale    = 0;
+       pars.angle    = 0;
+       pars.filename = filename;
+
+       if (!filepath.empty()) {
+               pars.filename = MakeAbsPath(pars.filename, filepath);
+       }
+
+       if (clip) {
+               pars.bb = bb;
+
+               // Get the original Bounding Box from the file
+               string const tmp = readBB_from_PSFile(filename);
+               lyxerr[Debug::GRAPHICS] << "BB_from_File: " << tmp << std::endl;
+               if (!tmp.empty()) {
+                       int const bb_orig_xl = strToInt(token(tmp, ' ', 0));
+                       int const bb_orig_yb = strToInt(token(tmp, ' ', 1));
+
+                       pars.bb.xl -= bb_orig_xl;
+                       pars.bb.xr -= bb_orig_xl;
+                       pars.bb.yb -= bb_orig_yb;
+                       pars.bb.yt -= bb_orig_yb;
+               }
+
+               pars.bb.xl = std::max(0, pars.bb.xl);
+               pars.bb.xr = std::max(0, pars.bb.xr);
+               pars.bb.yb = std::max(0, pars.bb.yb);
+               pars.bb.yt = std::max(0, pars.bb.yt);
+
+               // Paranoia check.
+               int const width  = pars.bb.xr - pars.bb.xl;
+               int const height = pars.bb.yt - pars.bb.yb;
+
+               if (width  < 0 || height < 0) {
+                       pars.bb.xl = 0;
+                       pars.bb.xr = 0;
+                       pars.bb.yb = 0;
+                       pars.bb.yt = 0;
+               }
+       }
+       
+       if (rotate)
+               pars.angle = int(rotateAngle);
+
+       if (display == InsetGraphicsParams::DEFAULT) {
+
+               if (lyxrc.display_graphics == "mono")
+                       pars.display = grfx::GParams::MONOCHROME;
+               else if (lyxrc.display_graphics == "gray")
+                       pars.display = grfx::GParams::GRAYSCALE;
+               else if (lyxrc.display_graphics == "color")
+                       pars.display = grfx::GParams::COLOR;
+               else
+                       pars.display = grfx::GParams::NONE;
+
+       } else if (display == InsetGraphicsParams::NONE) {
+               pars.display = grfx::GParams::NONE;
+
+       } else if (display == InsetGraphicsParams::MONOCHROME) {
+               pars.display = grfx::GParams::MONOCHROME;
+
+       } else if (display == InsetGraphicsParams::GRAYSCALE) {
+               pars.display = grfx::GParams::GRAYSCALE;
+
+       } else if (display == InsetGraphicsParams::COLOR) {
+               pars.display = grfx::GParams::COLOR;
+       }
+
+       // Override the above if we're not using a gui
+       if (!lyxrc.use_gui) {
+               pars.display = grfx::GParams::NONE;
+       }
+
+       if (lyxsize_type == InsetGraphicsParams::SCALE) {
+               pars.scale = lyxscale;
+
+       } else if (lyxsize_type == InsetGraphicsParams::WH) {
+               if (!lyxwidth.zero())
+                       pars.width  = lyxwidth.inPixels(1, 1);
+               if (!lyxheight.zero())
+                       pars.height = lyxheight.inPixels(1, 1);
+
+               // inPixels returns a value scaled by lyxrc.zoom.
+               // We want, therefore, to undo this.
+               double const scaling_factor = 100.0 / double(lyxrc.zoom);
+               pars.width  = uint(scaling_factor * pars.width);
+               pars.height = uint(scaling_factor * pars.height);
+       }
+       return pars;
+}