/src/libwps/src/lib/libwps_internal.h

Source
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/* libwps
 * Version: MPL 2.0 / LGPLv2.1+
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Major Contributor(s):
 * Copyright (C) 2002 William Lachance (william.lachance@sympatico.ca)
 * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
 *
 * For minor contributions see the git repository.
 *
 * Alternatively, the contents of this file may be used under the terms
 * of the GNU Lesser General Public License Version 2.1 or later
 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
 * applicable instead of those above.
 *
 * For further information visit http://libwps.sourceforge.net
 */

#ifndef LIBWPS_INTERNAL_H
#define LIBWPS_INTERNAL_H

#include <assert.h>
#ifdef DEBUG
#include <stdio.h>
#endif

#include <algorithm>
#include <cmath>
#include <iostream>
#include <map>
#include <memory>
#include <string>
#include <vector>

#include <librevenge-stream/librevenge-stream.h>
#include <librevenge/librevenge.h>

#ifndef M_PI
#define M_PI 3.14159265358979323846
#endif

#if defined(_MSC_VER) || defined(__DJGPP__)
typedef signed char int8_t;
typedef unsigned char uint8_t;
typedef signed short int16_t;
typedef unsigned short uint16_t;
typedef signed int int32_t;
typedef unsigned int uint32_t;
#else /* !_MSC_VER && !__DJGPP__*/
#  include <inttypes.h>
#endif /* _MSC_VER || __DJGPP__*/

/* ---------- time/...  --------------- */
#ifdef HAVE_CONFIG_H
#  include "config.h"
#endif

// define localtime_r on Windows, so that can use
// thread-safe functions on other environments
#ifdef _WIN32
#  define gmtime_r(tp,tmp) (gmtime(tp)?(*(tmp)=*gmtime(tp),(tmp)):0)
#  define localtime_r(tp,tmp) (localtime(tp)?(*(tmp)=*localtime(tp),(tmp)):0)
#endif

/** a noop deleter used to transform a librevenge pointer in a false std::shared_ptr */
template <class T>
struct WPS_shared_ptr_noop_deleter
{
  void operator()(T *) {}
};

/** fall through attributes */
#if defined(HAVE_CLANG_ATTRIBUTE_FALLTHROUGH)
#  define WPS_FALLTHROUGH [[clang::fallthrough]]
#elif defined(HAVE_GCC_ATTRIBUTE_FALLTHROUGH)
#  define WPS_FALLTHROUGH __attribute__((fallthrough))
#else
#  define WPS_FALLTHROUGH ((void) 0)
#endif

// basic classes and autoptr
/** shared pointer to librevenge::RVNGInputStream */
typedef std::shared_ptr<librevenge::RVNGInputStream> RVNGInputStreamPtr;

struct WPSStream;
class WPSCell;
class WPSListener;
class WPSContentListener;
class WPSEntry;
class WPSFont;
class WPSHeader;
class WPSPosition;
class WPSSubDocument;

class WKSContentListener;
class WKSSubDocument;

/** shared pointer to WPSCell */
typedef std::shared_ptr<WPSCell> WPSCellPtr;
/** shared pointer to WPSListener */
typedef std::shared_ptr<WPSListener> WPSListenerPtr;
/** shared pointer to WPSContentListener */
typedef std::shared_ptr<WPSContentListener> WPSContentListenerPtr;
/** shared pointer to WPSHeader */
typedef std::shared_ptr<WPSHeader> WPSHeaderPtr;
/** shared pointer to WPSSubDocument */
typedef std::shared_ptr<WPSSubDocument> WPSSubDocumentPtr;

/** shared pointer to WKSContentListener */
typedef std::shared_ptr<WKSContentListener> WKSContentListenerPtr;
/** shared pointer to WKSSubDocument */
typedef std::shared_ptr<WKSSubDocument> WKSSubDocumentPtr;

#if defined(HAVE_FUNC_ATTRIBUTE_FORMAT)
#  define WPS_ATTRIBUTE_PRINTF(fmt, arg) __attribute__((format(printf, fmt, arg)))
#else
#  define WPS_ATTRIBUTE_PRINTF(fmt, arg)
#endif

#define WPS_N_ELEMENTS(m) sizeof(m)/sizeof(m[0])

/* ---------- debug  --------------- */
#ifdef DEBUG
namespace libwps
{
void printDebugMsg(const char *format, ...) WPS_ATTRIBUTE_PRINTF(1, 2);
}
#define WPS_DEBUG_MSG(M) libwps::printDebugMsg M
#else
#define WPS_DEBUG_MSG(M)
#endif

/* ---------- exception  ------------ */
namespace libwps
{
// Various exceptions
class VersionException
{
  // needless to say, we could flesh this class out a bit
};

class FileException
{
  // needless to say, we could flesh this class out a bit
};

class ParseException
{
  // needless to say, we could flesh this class out a bit
};

class PasswordException
{
  // needless to say, we could flesh this class out a bit
};

class GenericException
{
  // needless to say, we could flesh this class out a bit
};
}

/* ---------- input ----------------- */
namespace libwps
{
uint8_t readU8(librevenge::RVNGInputStream *input);
uint16_t readU16(librevenge::RVNGInputStream *input);
uint32_t readU32(librevenge::RVNGInputStream *input);

int8_t read8(librevenge::RVNGInputStream *input);
int16_t read16(librevenge::RVNGInputStream *input);
int32_t read32(librevenge::RVNGInputStream *input);

inline uint8_t readU8(RVNGInputStreamPtr const &input)
{
  return readU8(input.get());
}
inline uint16_t readU16(RVNGInputStreamPtr const &input)
{
  return readU16(input.get());
}
inline uint32_t readU32(RVNGInputStreamPtr const &input)
{
  return readU32(input.get());
}

inline int8_t read8(RVNGInputStreamPtr const &input)
{
  return read8(input.get());
}
inline int16_t read16(RVNGInputStreamPtr const &input)
{
  return read16(input.get());
}
inline int32_t read32(RVNGInputStreamPtr const &input)
{
  return read32(input.get());
}

//! read a double store with 4 bytes: mantisse 2.5 bytes, exponent 1.5 bytes
bool readDouble4(RVNGInputStreamPtr &input, double &res, bool &isNaN);
//! read a double store with 8 bytes: mantisse 6.5 bytes, exponent 1.5 bytes
bool readDouble8(RVNGInputStreamPtr &input, long double &res, bool &isNaN);
//! read a double store with 10 bytes: mantisse 8 bytes, exponent 2 bytes
bool readDouble10(RVNGInputStreamPtr &input, long double &res, bool &isNaN);
//! read a double store with 2 bytes: exponent 1.5 bytes, kind of mantisse 0.5 bytes
bool readDouble2Inv(RVNGInputStreamPtr &input, double &res, bool &isNaN);
//! read a double store with 4 bytes: exponent 3.5 bytes, mantisse 0.5 bytes
bool readDouble4Inv(RVNGInputStreamPtr &input, double &res, bool &isNaN);

//! try to read sz bytes from input and store them in a librevenge::RVNGBinaryData
bool readData(RVNGInputStreamPtr &input, unsigned long sz, librevenge::RVNGBinaryData &data);
//! try to read the last bytes from input and store them in a librevenge::RVNGBinaryData
bool readDataToEnd(RVNGInputStreamPtr &input, librevenge::RVNGBinaryData &data);
//! adds an unicode character to a string ( with correct encoding ).
void appendUnicode(uint32_t val, librevenge::RVNGString &buffer);
}

#define WPS_LE_GET_GUINT16(p)                     \
        uint16_t(((reinterpret_cast<uint8_t const *>(p))[0] << 0)  |  \
                  ((reinterpret_cast<uint8_t const *>(p))[1] << 8))
#define WPS_LE_GET_GUINT32(p)               \
  uint32_t(((reinterpret_cast<uint8_t const *>(p))[0] << 0) |     \
                  ((reinterpret_cast<uint8_t const *>(p))[1] << 8)  | \
                  ((reinterpret_cast<uint8_t const *>(p))[2] << 16) | \
                  ((reinterpret_cast<uint8_t const *>(p))[3] << 24))

#define WPS_LE_PUT_GUINT16(p, v)                    \
  *(reinterpret_cast<uint8_t*>(p)) = uint8_t(v);              \
  *((reinterpret_cast<uint8_t*>(p)) + 1) = uint8_t((v) >> 8)

#define WPS_LE_PUT_GUINT32(p, v)                    \
  *(reinterpret_cast<uint8_t*>(p)) = uint8_t(v);              \
  *((reinterpret_cast<uint8_t*>(p)) + 1) = uint8_t((v) >> 8);     \
  *((reinterpret_cast<uint8_t*>(p)) + 2) = uint8_t((v) >> 16);    \
  *((reinterpret_cast<uint8_t*>(p)) + 3) = uint8_t((v) >> 24)

// Various helper structures for the parser..
/* ---------- small enum/class ------------- */
namespace libwps
{
enum NumberingType { NONE, BULLET, ARABIC, LOWERCASE, UPPERCASE, LOWERCASE_ROMAN, UPPERCASE_ROMAN };
std::string numberingTypeToString(NumberingType type);
enum SubDocumentType { DOC_NONE, DOC_HEADER_FOOTER, DOC_NOTE, DOC_TABLE, DOC_TEXT_BOX, DOC_COMMENT_ANNOTATION, DOC_CHART_ZONE };
enum Justification { JustificationLeft, JustificationFull, JustificationCenter,
                     JustificationRight, JustificationFullAllLines
                   };
enum { NoBreakBit = 0x1, NoBreakWithNextBit=0x2};
}

struct WPSColumnDefinition
{
  WPSColumnDefinition()
    : m_width(0)
    , m_leftGutter(0)
    , m_rightGutter(0)
  {
  }
  double m_width;
  double m_leftGutter;
  double m_rightGutter;
};

struct WPSColumnProperties
{
  WPSColumnProperties()
    : m_attributes(0)
    , m_alignment(0)
  {
  }
  uint32_t m_attributes;
  uint8_t m_alignment;
};

//! the class to store a color
struct WPSColor
{
  //! constructor
  explicit WPSColor(uint32_t argb=0) : m_value(argb)
  {
  }
  //! constructor from color
  WPSColor(unsigned char r, unsigned char g,  unsigned char b, unsigned char a=255) :
    m_value(uint32_t((a<<24)+(r<<16)+(g<<8)+b))
  {
  }
  //! copy constructor
  WPSColor(WPSColor const &) = default;
  //! move assignement
  WPSColor(WPSColor &&) = default;
  //! operator=
  WPSColor &operator=(uint32_t argb)
  {
    m_value = argb;
    return *this;
  }
  //! operator=
  WPSColor &operator=(WPSColor const &) = default;
  //! move operator=
  WPSColor &operator=(WPSColor &&) = default;
  //! return the back color
  static WPSColor black()
  {
    return WPSColor(0,0,0);
  }
  //! return the white color
  static WPSColor white()
  {
    return WPSColor(255,255,255);
  }

  //! return alpha*colA+beta*colB
  static WPSColor barycenter(float alpha, WPSColor const &colA,
                             float beta, WPSColor const &colB);
  //! return the rgba value
  uint32_t value() const
  {
    return m_value;
  }
  //! returns the alpha value
  unsigned char getAlpha() const
  {
    return static_cast<unsigned char>((m_value>>24)&0xFF);
  }
  //! returns the green value
  unsigned char getBlue() const
  {
    return static_cast<unsigned char>(m_value&0xFF);
  }
  //! returns the red value
  unsigned char getRed() const
  {
    return static_cast<unsigned char>((m_value>>16)&0xFF);
  }
  //! returns the green value
  unsigned char getGreen() const
  {
    return static_cast<unsigned char>((m_value>>8)&0xFF);
  }
  //! return true if the color is black
  bool isBlack() const
  {
    return (m_value&0xFFFFFF)==0;
  }
  //! return true if the color is white
  bool isWhite() const
  {
    return (m_value&0xFFFFFF)==0xFFFFFF;
  }
  //! operator==
  bool operator==(WPSColor const &c) const
  {
    return (c.m_value&0xFFFFFF)==(m_value&0xFFFFFF);
  }
  //! operator!=
  bool operator!=(WPSColor const &c) const
  {
    return !operator==(c);
  }
  //! operator<
  bool operator<(WPSColor const &c) const
  {
    return (c.m_value&0xFFFFFF)<(m_value&0xFFFFFF);
  }
  //! operator<=
  bool operator<=(WPSColor const &c) const
  {
    return (c.m_value&0xFFFFFF)<=(m_value&0xFFFFFF);
  }
  //! operator>
  bool operator>(WPSColor const &c) const
  {
    return !operator<=(c);
  }
  //! operator>=
  bool operator>=(WPSColor const &c) const
  {
    return !operator<(c);
  }
  //! operator<< in the form \#rrggbb
  friend std::ostream &operator<< (std::ostream &o, WPSColor const &c);
  //! print the color in the form \#rrggbb
  std::string str() const;
protected:
  //! the argb color
  uint32_t m_value;
};

//! a border list
struct WPSBorder
{
  /** the line style */
  enum Style { None, Simple, Dot, LargeDot, Dash };
  /** the line repetition */
  enum Type { Single, Double, Triple };
  enum Pos { Left = 0, Right = 1, Top = 2, Bottom = 3 };
  enum { LeftBit = 0x01,  RightBit = 0x02, TopBit=0x4, BottomBit = 0x08 };

  //! constructor
  WPSBorder()
    : m_style(Simple)
    , m_type(Single)
    , m_width(1)
    , m_widthsList()
    , m_color(WPSColor::black())
    , m_extra("") { }

  WPSBorder(WPSBorder const &) = default;
  WPSBorder(WPSBorder &&) = default;
  WPSBorder &operator=(WPSBorder const &) = default;
  WPSBorder &operator=(WPSBorder &&) = default;

  /** add the border property to proplist (if needed )

    \note if set which must be equal to "left", "top", ... */
  bool addTo(librevenge::RVNGPropertyList &propList, std::string which="") const;
  //! returns true if the border is empty
  bool isEmpty() const
  {
    return m_style==None || m_width <= 0;
  }

  //! operator==
  bool operator==(WPSBorder const &orig) const
  {
    return m_style == orig.m_style && m_type == orig.m_type && m_width == orig.m_width
      && m_color == orig.m_color && m_widthsList==orig.m_widthsList;
  }
  //! operator!=
  bool operator!=(WPSBorder const &orig) const
  {
    return !operator==(orig);
  }
  //! compare two cell
  int compare(WPSBorder const &orig) const;

  //! operator<<
  friend std::ostream &operator<< (std::ostream &o, WPSBorder const &border);
  //! operator<<: prints data in form "none|dot|..."
  friend std::ostream &operator<< (std::ostream &o, WPSBorder::Style const &style);
  //! the border style
  Style m_style;
  //! the border repetition
  Type m_type;
  //! the border width
  int m_width;
  /** the different length used for each line/sep (if defined)

    \note when defined, the size of this list must be equal to 2*Type-1*/
  std::vector<double> m_widthsList;
  //! the border color
  WPSColor m_color;
  //! extra data ( if needed)
  std::string m_extra;
};

//! a field
struct WPSField
{
  /** Defines some basic type for field */
  enum Type { None, Database, Date, Link, PageCount, PageNumber, PageNumberNext, Time, Title };

  /** basic constructor */
  explicit WPSField(Type type)
    : m_type(type)
    , m_DTFormat("")
    , m_numberingType(libwps::ARABIC)
    , m_data("")
  {
  }
  WPSField(WPSField &&) = default;
  WPSField(WPSField const &) = default;
  WPSField &operator=(WPSField const &) = default;
  WPSField &operator=(WPSField &&) = default;
  /** add the link property to proplist (if possible) */
  bool addTo(librevenge::RVNGPropertyList &propList) const;
  //! returns a string corresponding to the field (if possible) */
  librevenge::RVNGString getString() const;
  //! the type
  Type m_type;
  //! the date/time format using strftime format if defined (see strftime)
  std::string m_DTFormat;
  //! the number type ( for number field )
  libwps::NumberingType m_numberingType;
  //! the database/link field ( if defined )
  std::string m_data;
};

// ATTRIBUTE bits
#define WPS_EXTRA_LARGE_BIT 1
#define WPS_VERY_LARGE_BIT 2
#define WPS_LARGE_BIT 4
#define WPS_SMALL_PRINT_BIT 8
#define WPS_FINE_PRINT_BIT 0x10
#define WPS_SUPERSCRIPT_BIT 0x20
#define WPS_SUBSCRIPT_BIT 0x40
#define WPS_OUTLINE_BIT 0x80
#define WPS_ITALICS_BIT 0x100
#define WPS_SHADOW_BIT 0x200
#define WPS_REDLINE_BIT 0x400
#define WPS_DOUBLE_UNDERLINE_BIT 0x800
#define WPS_BOLD_BIT 0x1000
#define WPS_STRIKEOUT_BIT 0x2000
#define WPS_UNDERLINE_BIT 0x4000
#define WPS_SMALL_CAPS_BIT 0x8000
#define WPS_BLINK_BIT 0x10000L
#define WPS_REVERSEVIDEO_BIT 0x20000L
#define WPS_ALL_CAPS_BIT 0x40000L
#define WPS_EMBOSS_BIT 0x80000L
#define WPS_ENGRAVE_BIT 0x100000L
#define WPS_OVERLINE_BIT 0x400000L
#define WPS_HIDDEN_BIT 0x800000L

// BREAK bits
#define WPS_PAGE_BREAK 0x00
#define WPS_SOFT_PAGE_BREAK 0x01
#define WPS_COLUMN_BREAK 0x02

// Generic bits
#define WPS_LEFT 0x00
#define WPS_RIGHT 0x01
#define WPS_CENTER 0x02
#define WPS_TOP 0x03
#define WPS_BOTTOM 0x04

/* ---------- vec2/box2f ------------- */
/*! \class Vec2
 *   \brief small class which defines a vector with 2 elements
 */
template <class T> class Vec2
{
public:
  //! constructor
  explicit Vec2(T xx=0,T yy=0) : m_x(xx), m_y(yy) { }
  //! generic copy constructor
  template <class U> explicit Vec2(Vec2<U> const &p) : m_x(T(p.x())), m_y(T(p.y())) {}
  //! first element
  T x() const
  {
    return m_x;
  }
  //! second element
  T y() const
  {
    return m_y;
  }
  //! operator[]
  T operator[](int c) const
  {
    if (c<0 || c>1) throw libwps::GenericException();
    return (c==0) ? m_x : m_y;
  }
  //! operator[]
  T &operator[](int c)
  {
    if (c<0 || c>1) throw libwps::GenericException();
    return (c==0) ? m_x : m_y;
  }

  //! resets the two elements
  void set(T xx, T yy)
  {
    m_x = xx;
    m_y = yy;
  }
  //! resets the first element
  void setX(T xx)
  {
    m_x = xx;
  }
  //! resets the second element
  void setY(T yy)
  {
    m_y = yy;
  }

  //! increases the actuals values by \a dx and \a dy
  void add(T dx, T dy)
  {
    m_x += dx;
    m_y += dy;
  }

  //! operator+=
  Vec2<T> &operator+=(Vec2<T> const &p)
  {
    m_x += p.m_x;
    m_y += p.m_y;
    return *this;
  }
  //! operator-=
  Vec2<T> &operator-=(Vec2<T> const &p)
  {
    m_x -= p.m_x;
    m_y -= p.m_y;
    return *this;
  }
  //! generic operator*=
  template <class U>
  Vec2<T> &operator*=(U scale)
  {
    m_x = m_x*T(scale);
    m_y = m_y*T(scale);
    return *this;
  }

  //! operator+
  friend Vec2<T> operator+(Vec2<T> const &p1, Vec2<T> const &p2)
  {
    Vec2<T> p(p1);
    return p+=p2;
  }
  //! operator-
  friend Vec2<T> operator-(Vec2<T> const &p1, Vec2<T> const &p2)
  {
    Vec2<T> p(p1);
    return p-=p2;
  }
  //! generic operator*
  template <class U>
  friend Vec2<T> operator*(U scale, Vec2<T> const &p1)
  {
    Vec2<T> p(p1);
    return p *= scale;
  }

  //! comparison==
  bool operator==(Vec2<T> const &p) const
  {
    return cmpY(p) == 0;
  }
  //! comparison!=
  bool operator!=(Vec2<T> const &p) const
  {
    return cmpY(p) != 0;
  }
  //! comparison<: sort by y
  bool operator<(Vec2<T> const &p) const
  {
    return cmpY(p) < 0;
  }
  //! a comparison function: which first compares x then y
  int cmp(Vec2<T> const &p) const
  {
    if (m_x<p.m_x) return -1;
    if (m_x>p.m_x) return 1;
    if (m_y<p.m_y) return -1;
    if (m_y>p.m_y) return 1;
    return 0;
  }
  //! a comparison function: which first compares y then x
  int cmpY(Vec2<T> const &p) const
  {
    if (m_y<p.m_y) return -1;
    if (m_y>p.m_y) return 1;
    if (m_x<p.m_x) return -1;
    if (m_x>p.m_x) return 1;
    return 0;
  }

  //! operator<<: prints data in form "XxY"
  friend std::ostream &operator<< (std::ostream &o, Vec2<T> const &f)
  {
    o << f.m_x << "x" << f.m_y;
    return o;
  }

  /*! \struct PosSizeLtX
   * \brief internal struct used to create sorted map, sorted by X
   */
  struct PosSizeLtX
  {
    //! comparaison function
    bool operator()(Vec2<T> const &s1, Vec2<T> const &s2) const
    {
      return s1.cmp(s2) < 0;
    }
  };

  /*! \struct PosSizeLtY
   * \brief internal struct used to create sorted map, sorted by Y
   */
  struct PosSizeLtY
  {
    //! comparaison function
    bool operator()(Vec2<T> const &s1, Vec2<T> const &s2) const
    {
      return s1.cmpY(s2) < 0;
    }
  };
protected:
  T m_x/*! \brief first element */, m_y/*! \brief second element */;
};

/*! \brief Vec2 of bool */
typedef Vec2<bool> Vec2b;
/*! \brief Vec2 of int */
typedef Vec2<int> Vec2i;
/*! \brief Vec2 of float */
typedef Vec2<float> Vec2f;

/*! \class WPSBox2
 *   \brief small class which defines a 2D WPSBox
 */
template <class T> class WPSBox2
{
public:
  //! constructor
  explicit WPSBox2(Vec2<T> minPt=Vec2<T>(), Vec2<T> maxPt=Vec2<T>())
  {
    m_pt[0] = minPt;
    m_pt[1] = maxPt;
  }
  //! generic constructor
  template <class U> explicit WPSBox2(WPSBox2<U> const &p)
  {
    for (int c=0; c < 2; c++) m_pt[c] = Vec2<T>(p[c]);
  }

  //! the minimum 2D point (in x and in y)
  Vec2<T> const &min() const
  {
    return m_pt[0];
  }
  //! the maximum 2D point (in x and in y)
  Vec2<T> const &max() const
  {
    return m_pt[1];
  }
  //! the minimum 2D point (in x and in y)
  Vec2<T> &min()
  {
    return m_pt[0];
  }
  //! the maximum 2D point (in x and in y)
  Vec2<T> &max()
  {
    return m_pt[1];
  }

  /*! \brief the two extremum points which defined the box
   * \param c value 0 means the minimum, value 1 means the maximum
   */
  Vec2<T> const &operator[](int c) const
  {
    if (c<0 || c>1) throw libwps::GenericException();
    return m_pt[c];
  }
  //! the box size
  Vec2<T> size() const
  {
    return m_pt[1]-m_pt[0];
  }
  //! the box center
  Vec2<T> center() const
  {
    return 0.5*(m_pt[0]+m_pt[1]);
  }

  //! resets the data to minimum \a x and maximum \a y
  void set(Vec2<T> const &x, Vec2<T> const &y)
  {
    m_pt[0] = x;
    m_pt[1] = y;
  }
  //! resets the minimum point
  void setMin(Vec2<T> const &x)
  {
    m_pt[0] = x;
  }
  //! resets the maximum point
  void setMax(Vec2<T> const &y)
  {
    m_pt[1] = y;
  }

  //!  resize the box keeping the minimum
  void resizeFromMin(Vec2<T> const &sz)
  {
    m_pt[1] = m_pt[0]+sz;
  }
  //!  resize the box keeping the maximum
  void resizeFromMax(Vec2<T> const &sz)
  {
    m_pt[0] = m_pt[1]-sz;
  }
  //!  resize the box keeping the center
  void resizeFromCenter(Vec2<T> const &sz)
  {
    Vec2<T> ctr = 0.5*(m_pt[0]+m_pt[1]);
    m_pt[0] = ctr - 0.5*sz;
    m_pt[1] = ctr + (sz - 0.5*sz);
  }

  //! scales all points of the box by \a factor
  template <class U> void scale(U factor)
  {
    m_pt[0] *= factor;
    m_pt[1] *= factor;
  }

  //! extends the bdbox by (\a val, \a val) keeping the center
  void extend(T val)
  {
    m_pt[0] -= Vec2<T>(val/2,val/2);
    m_pt[1] += Vec2<T>(val-(val/2),val-(val/2));
  }
  //! returns the union between this and box
  WPSBox2<T> getUnion(WPSBox2<T> const &box) const
  {
    WPSBox2<T> res;
    res.m_pt[0]=Vec2<T>(m_pt[0][0]<box.m_pt[0][0]?m_pt[0][0] : box.m_pt[0][0],
                        m_pt[0][1]<box.m_pt[0][1]?m_pt[0][1] : box.m_pt[0][1]);
    res.m_pt[1]=Vec2<T>(m_pt[1][0]>box.m_pt[1][0]?m_pt[1][0] : box.m_pt[1][0],
                        m_pt[1][1]>box.m_pt[1][1]?m_pt[1][1] : box.m_pt[1][1]);
    return res;
  }
  //! returns the intersection between this and box
  WPSBox2<T> getIntersection(WPSBox2<T> const &box) const
  {
    WPSBox2<T> res;
    res.m_pt[0]=Vec2<T>(m_pt[0][0]>box.m_pt[0][0]?m_pt[0][0] : box.m_pt[0][0],
                        m_pt[0][1]>box.m_pt[0][1]?m_pt[0][1] : box.m_pt[0][1]);
    res.m_pt[1]=Vec2<T>(m_pt[1][0]<box.m_pt[1][0]?m_pt[1][0] : box.m_pt[1][0],
                        m_pt[1][1]<box.m_pt[1][1]?m_pt[1][1] : box.m_pt[1][1]);
    return res;
  }

  //! comparison operator==
  bool operator==(WPSBox2<T> const &p) const
  {
    return cmp(p) == 0;
  }
  //! comparison operator!=
  bool operator!=(WPSBox2<T> const &p) const
  {
    return cmp(p) != 0;
  }
  //! comparison operator< : fist sorts min by Y,X values then max extremity
  bool operator<(WPSBox2<T> const &p) const
  {
    return cmp(p) < 0;
  }

  //! comparison function : fist sorts min by Y,X values then max extremity
  int cmp(WPSBox2<T> const &p) const
  {
    int diff  = m_pt[0].cmpY(p.m_pt[0]);
    if (diff) return diff;
    diff  = m_pt[1].cmpY(p.m_pt[1]);
    if (diff) return diff;
    return 0;
  }

  //! print data in form X0xY0<->X1xY1
  friend std::ostream &operator<< (std::ostream &o, WPSBox2<T> const &f)
  {
    o << "(" << f.m_pt[0] << "<->" << f.m_pt[1] << ")";
    return o;
  }

  /*! \struct PosSizeLt
   * \brief internal struct used to create sorted map, sorted first min then max
   */
  struct PosSizeLt
  {
    //! comparaison function
    bool operator()(WPSBox2<T> const &s1, WPSBox2<T> const &s2) const
    {
      return s1.cmp(s2) < 0;
    }
  };
  /*! \typedef Map
   *  \brief map of WPSBox2
   */
  typedef std::map<WPSBox2<T>, T, struct PosSizeLt> Map;

protected:
  //! the two extremities
  Vec2<T> m_pt[2];
};

/*! \brief WPSBox2 of int */
typedef WPSBox2<int> WPSBox2i;
/*! \brief WPSBox2 of float */
typedef WPSBox2<float> WPSBox2f;

/*! \class WPSVec3
 *   \brief small class which defines a vector with 3 elements
 */
template <class T> class WPSVec3
{
public:
  //! constructor
  explicit WPSVec3(T xx=0,T yy=0,T zz=0)
  {
    m_val[0] = xx;
    m_val[1] = yy;
    m_val[2] = zz;
  }
  //! generic copy constructor
  template <class U> explicit WPSVec3(WPSVec3<U> const &p)
  {
    for (int c = 0; c < 3; c++) m_val[c] = T(p[c]);
  }

  //! first element
  T x() const
  {
    return m_val[0];
  }
  //! second element
  T y() const
  {
    return m_val[1];
  }
  //! third element
  T z() const
  {
    return m_val[2];
  }
  //! operator[]
  T operator[](int c) const
  {
    if (c<0 || c>2) throw libwps::GenericException();
    return m_val[c];
  }
  //! operator[]
  T &operator[](int c)
  {
    if (c<0 || c>2) throw libwps::GenericException();
    return m_val[c];
  }

  //! resets the three elements
  void set(T xx, T yy, T zz)
  {
    m_val[0] = xx;
    m_val[1] = yy;
    m_val[2] = zz;
  }
  //! resets the first element
  void setX(T xx)
  {
    m_val[0] = xx;
  }
  //! resets the second element
  void setY(T yy)
  {
    m_val[1] = yy;
  }
  //! resets the third element
  void setZ(T zz)
  {
    m_val[2] = zz;
  }

  //! increases the actuals values by \a dx, \a dy, \a dz
  void add(T dx, T dy, T dz)
  {
    m_val[0] += dx;
    m_val[1] += dy;
    m_val[2] += dz;
  }

  //! operator+=
  WPSVec3<T> &operator+=(WPSVec3<T> const &p)
  {
    for (int c = 0; c < 3; c++) m_val[c] = T(m_val[c]+p.m_val[c]);
    return *this;
  }
  //! operator-=
  WPSVec3<T> &operator-=(WPSVec3<T> const &p)
  {
    for (int c = 0; c < 3; c++) m_val[c] = T(m_val[c]-p.m_val[c]);
    return *this;
  }
  //! generic operator*=
  template <class U>
  WPSVec3<T> &operator*=(U scale)
  {
    for (auto &c : m_val) c = T(c*scale);
    return *this;
  }

  //! operator+
  friend WPSVec3<T> operator+(WPSVec3<T> const &p1, WPSVec3<T> const &p2)
  {
    WPSVec3<T> p(p1);
    return p+=p2;
  }
  //! operator-
  friend WPSVec3<T> operator-(WPSVec3<T> const &p1, WPSVec3<T> const &p2)
  {
    WPSVec3<T> p(p1);
    return p-=p2;
  }
  //! generic operator*
  template <class U>
  friend WPSVec3<T> operator*(U scale, WPSVec3<T> const &p1)
  {
    WPSVec3<T> p(p1);
    return p *= scale;
  }

  //! comparison==
  bool operator==(WPSVec3<T> const &p) const
  {
    return cmp(p) == 0;
  }
  //! comparison!=
  bool operator!=(WPSVec3<T> const &p) const
  {
    return cmp(p) != 0;
  }
  //! comparison<: which first compares x values, then y values then z values.
  bool operator<(WPSVec3<T> const &p) const
  {
    return cmp(p) < 0;
  }
  //! a comparison function: which first compares x values, then y values then z values.
  int cmp(WPSVec3<T> const &p) const
  {
    for (int c = 0; c < 3; c++)
    {
      if (m_val[c]<p.m_val[c]) return -1;
      if (m_val[c]>p.m_val[c]) return 1;
    }
    return 0;
  }

  //! operator<<: prints data in form "XxYxZ"
  friend std::ostream &operator<< (std::ostream &o, WPSVec3<T> const &f)
  {
    o << f.m_val[0] << "x" << f.m_val[1] << "x" << f.m_val[2];
    return o;
  }

  /*! \struct PosSizeLt
   * \brief internal struct used to create sorted map, sorted by X, Y, Z
   */
  struct PosSizeLt
  {
    //! comparaison function
    bool operator()(WPSVec3<T> const &s1, WPSVec3<T> const &s2) const
    {
      return s1.cmp(s2) < 0;
    }
  };
  /*! \typedef Map
   *  \brief map of WPSVec3
   */
  typedef std::map<WPSVec3<T>, T, struct PosSizeLt> Map;

protected:
  //! the values
  T m_val[3];
};

/*! \brief WPSVec3 of unsigned char */
typedef WPSVec3<unsigned char> WPSVec3uc;
/*! \brief WPSVec3 of int */
typedef WPSVec3<int> WPSVec3i;
/*! \brief WPSVec3 of float */
typedef WPSVec3<float> WPSVec3f;


/** small class use to define a embedded object

    \note mainly used to store picture
 */
struct WPSEmbeddedObject
{
  //! empty constructor
  WPSEmbeddedObject() : m_size(), m_dataList(), m_typeList(), m_sent(false)
  {
  }
  WPSEmbeddedObject(WPSEmbeddedObject const &) = default;
  WPSEmbeddedObject &operator=(WPSEmbeddedObject const &) = default;
  WPSEmbeddedObject(WPSEmbeddedObject &&) = default;
  WPSEmbeddedObject &operator=(WPSEmbeddedObject &&) = default;
  //! constructor
  explicit WPSEmbeddedObject(librevenge::RVNGBinaryData const &binaryData, std::string const &type="image/pict") :
    m_size(), m_dataList(), m_typeList(), m_sent(false)
  {
    add(binaryData, type);
  }
  //! destructor
  virtual ~WPSEmbeddedObject();
  //! return true if the picture contains no data
  bool isEmpty() const
  {
    for (auto const &data : m_dataList)
    {
      if (!data.empty())
        return false;
    }
    return true;
  }
  //! add a picture
  void add(librevenge::RVNGBinaryData const &binaryData, std::string const &type="image/pict")
  {
    size_t pos=m_dataList.size();
    if (pos<m_typeList.size()) pos=m_typeList.size();
    m_dataList.resize(pos+1);
    m_dataList[pos]=binaryData;
    m_typeList.resize(pos+1);
    m_typeList[pos]=type;
  }
  /** add the link property to proplist */
  bool addTo(librevenge::RVNGPropertyList &propList) const;
  /** operator<<*/
  friend std::ostream &operator<<(std::ostream &o, WPSEmbeddedObject const &pict);

  //! the picture size in inches(if known)
  Vec2f m_size;
  //! the picture content: one data by representation
  std::vector<librevenge::RVNGBinaryData> m_dataList;
  //! the picture type: one type by representation
  std::vector<std::string> m_typeList;
  //! a mutable flag which can be used to know if the picture was send to a listener
  mutable bool m_sent;
};

/** a transformation which stored the first row of a 3x3 perspective matrix */
class WPSTransformation
{
public:
  //! constructor
  explicit WPSTransformation(WPSVec3f const &xRow=WPSVec3f(1,0,0), WPSVec3f const &yRow=WPSVec3f(0,1,0))
    : m_data(xRow, yRow)
    , m_isIdentity(false)
  {
    checkIdentity();
  }
  WPSTransformation(WPSTransformation const &)=default;
  WPSTransformation(WPSTransformation &&)=default;
  WPSTransformation &operator=(WPSTransformation const &)=default;
  WPSTransformation &operator=(WPSTransformation &&)=default;
  //! returns true if the matrix is an identity matrix
  bool isIdentity() const
  {
    return m_isIdentity;
  }
  //! check if a matrix is the identity matrix
  void checkIdentity() const
  {
    m_isIdentity= m_data.first==WPSVec3f(1,0,0) && m_data.second==WPSVec3f(0,1,0);
  }
  /*! \brief the two extremum points which defined the box
   * \param c 0 means the minimum and 1 the maximum
   */
  WPSVec3f const &operator[](int c) const
  {
    if (c<0 || c>1) throw libwps::GenericException();
    return c==0 ? m_data.first : m_data.second;
  }
  //! operator* for vec2f
  Vec2f operator*(Vec2f const &pt) const
  {
    if (m_isIdentity) return pt;
    return multiplyDirection(pt)+Vec2f(m_data.first[2],m_data.second[2]);
  }
  //! operator* for direction
  Vec2f multiplyDirection(Vec2f const &dir) const
  {
    if (m_isIdentity) return dir;
    Vec2f res;
    for (int coord=0; coord<2; ++coord)
    {
      WPSVec3f const &row=coord==0 ? m_data.first : m_data.second;
      float value=0;
      for (int i=0; i<2; ++i)
        value+=row[i]*dir[i];
      res[coord]=value;
    }
    return res;
  }
  //! operator* for box2f
  WPSBox2f operator*(WPSBox2f const &box) const
  {
    if (m_isIdentity) return box;
    return WPSBox2f(operator*(box.min()), operator*(box.max()));
  }
  //! operator* for transform
  WPSTransformation operator*(WPSTransformation const &mat) const
  {
    if (mat.m_isIdentity) return *this;
    WPSTransformation res;
    for (int row=0; row<2; ++row)
    {
      WPSVec3f &resRow=row==0 ? res.m_data.first : res.m_data.second;
      for (int col=0; col<3; ++col)
      {
        float value=0;
        for (int i=0; i<3; ++i)
          value+=(*this)[row][i]*(i==2 ? (col==2 ? 1.f : 0.f) : mat[i][col]);
        resRow[col]=value;
      }
    }
    res.checkIdentity();
    return res;
  }
  //! operator*=
  WPSTransformation &operator*=(WPSTransformation const &mat)
  {
    if (!mat.m_isIdentity)
      *this=(*this)*mat;
    return *this;
  }
  //! operator==
  bool operator==(WPSTransformation const &mat) const
  {
    return m_data==mat.m_data;
  }
  //! operator!=
  bool operator!=(WPSTransformation const &mat) const
  {
    return m_data!=mat.m_data;
  }
  //! operator<
  bool operator<(WPSTransformation const &mat) const
  {
    return m_data<mat.m_data;
  }
  //! operator<=
  bool operator<=(WPSTransformation const &mat) const
  {
    return m_data<=mat.m_data;
  }
  //! operator>
  bool operator>(WPSTransformation const &mat) const
  {
    return m_data>mat.m_data;
  }
  //! operator>=
  bool operator>=(WPSTransformation const &mat) const
  {
    return m_data>=mat.m_data;
  }
  /** try to decompose the matrix in a rotation + scaling/translation matrix.

      Note: the center of rotation is given before applying the transformation(this) */
  bool decompose(float &rotation, Vec2f &shearing, WPSTransformation &transform, Vec2f const &center) const;

  /** returns a translation transformation */
  static WPSTransformation translation(Vec2f const &trans)
  {
    return WPSTransformation(WPSVec3f(1, 0, trans[0]), WPSVec3f(0, 1, trans[1]));
  }
  /** returns a scaling transformation */
  static WPSTransformation scale(Vec2f const &trans)
  {
    return WPSTransformation(WPSVec3f(trans[0], 0, 0), WPSVec3f(0, trans[1], 0));
  }
  /** returns a rotation transformation around center.

   \note angle must be given in degree */
  static WPSTransformation rotation(float angle, Vec2f const &center=Vec2f(0,0));
  /** returns a shear transformation letting center invariant, ie. a matrix
      ( 1 s[0] -s[0]*center[1], s[1] 1 -s[1]*center[0], 0 0 1)
   */
  static WPSTransformation shear(Vec2f s, Vec2f const &center=Vec2f(0,0))
  {
    return WPSTransformation(WPSVec3f(1, s[0], -s[0]*center[1]), WPSVec3f(s[1], 1, -s[1]*center[0]));
  }
protected:
  //! the data
  std::pair<WPSVec3f, WPSVec3f > m_data;
  //! flag to know if this matrix is an identity matrix
  mutable bool m_isIdentity;
};

//
// utility
//

namespace libwps
{
//! returns the cell name corresponding to a cell's position
std::string getCellName(Vec2i const &cellPos, Vec2b const &relative=Vec2b(true,true));
//! returns the checksum and the keys (to encode a lotus file) given a password file
bool encodeLotusPassword(char const *password, uint16_t &key, std::vector<uint8_t> &keys, uint8_t const(&defValues)[16]);
}
#endif /* LIBWPS_INTERNAL_H */
/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */

Coverage Report

Created: 2026-09-06 07:18