/usr/include/podofo/doc/PdfFontMetrics.h is in libpodofo-dev 0.9.0-1.2+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 | /***************************************************************************
* Copyright (C) 2005 by Dominik Seichter *
* domseichter@web.de *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Library General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/
#ifndef _PDF_FONT_METRICS_H_
#define _PDF_FONT_METRICS_H_
#include "podofo/base/PdfDefines.h"
#include "podofo/base/Pdf3rdPtyForwardDecl.h"
#include "podofo/base/PdfString.h"
namespace PoDoFo {
class PdfArray;
class PdfObject;
class PdfVariant;
/**
* This abstract class provides access
* to fontmetrics informations.
*/
class PODOFO_DOC_API PdfFontMetrics {
public:
PdfFontMetrics( EPdfFontType eFontType, const char* pszFilename, const char* pszSubsetPrefix );
virtual ~PdfFontMetrics();
/** Create a width array for this font which is a required part
* of every font dictionary.
* \param var the final width array is written to this PdfVariant
* \param nFirst first character to be in the array
* \param nLast last character code to be in the array
*/
virtual void GetWidthArray( PdfVariant & var, unsigned int nFirst, unsigned int nLast ) const = 0;
/** Get the width of a single glyph id
*
* \param nGlyphId id of the glyph
* \returns the width of a single glyph id
*/
virtual double GetGlyphWidth( int nGlyphId ) const = 0;
/** Get the width of a single named glyph
*
* \param pszGlyphname name of the glyph
* \returns the width of a single named glyph
*/
virtual double GetGlyphWidth( const char* pszGlyphname ) const = 0;
/** Create the bounding box array as required by the PDF reference
* so that it can be written directly to a PDF file.
*
* \param array write the bounding box to this array.
*/
virtual void GetBoundingBox( PdfArray & array ) const = 0;
/** Retrieve the width of a given text string in PDF units when
* drawn with the current font
* \param rsString a PdfString from which the width shall be calculated
* \returns the width in PDF units
*
* This is an overloaded method for your convinience!
*/
inline double StringWidth( const PdfString & rsString ) const;
/** Retrieve the width of a given text string in PDF units when
* drawn with the current font
* \param pszText a text string of which the width should be calculated
* \param nLength if != 0 only the width of the nLength first characters is calculated
* \returns the width in PDF units
*/
double StringWidth( const char* pszText, pdf_long nLength = 0 ) const;
/** Retrieve the width of a given text string in PDF units when
* drawn with the current font
* \param pszText a text string of which the width should be calculated
* \param nLength if != 0 only the width of the nLength first characters is calculated
* \returns the width in PDF units
*/
double StringWidth( const pdf_utf16be* pszText, unsigned int nLength = 0 ) const;
#ifndef _WCHAR_T_DEFINED
#if defined(_MSC_VER) && _MSC_VER <= 1200 // nicht für Visualstudio 6
#else
/** Retrieve the width of a given text string in PDF units when
* drawn with the current font
* \param pszText a text string of which the width should be calculated
* \param nLength if != 0 only the width of the nLength first characters is calculated
* \returns the width in PDF units
*/
double StringWidth( const wchar_t* pszText, unsigned int nLength = 0 ) const;
#endif
#endif
/** Retrieve the width of a given text string in 1/1000th mm when
* drawn with the current font
* \param pszText a text string of which the width should be calculated
* \param nLength if != 0 only the width of the nLength first characters is calculated
* \returns the width in 1/1000th mm
*/
inline unsigned long StringWidthMM( const char* pszText, unsigned int nLength = 0 ) const;
/** Retrieve the width of a given text string in 1/1000th mm when
* drawn with the current font
* \param pszText a text string of which the width should be calculated
* \param nLength if != 0 only the width of the nLength first characters is calculated
* \returns the width in 1/1000th mm
*/
inline unsigned long StringWidthMM( const pdf_utf16be* pszText, unsigned int nLength = 0 ) const;
#ifndef _WCHAR_T_DEFINED
#if defined(_MSC_VER) && _MSC_VER <= 1200 // nicht für Visualstudio 6
#else
/** Retrieve the width of a given text string in 1/1000th mm when
* drawn with the current font
* \param pszText a text string of which the width should be calculated
* \param nLength if != 0 only the width of the nLength first characters is calculated
* \returns the width in 1/1000th mm
*/
inline unsigned long StringWidthMM( const wchar_t* pszText, unsigned int nLength = 0 ) const;
#endif
#endif
/** Retrieve the width of the given character in PDF units in the current font
* \param c character
* \returns the width in PDF units
*/
virtual double CharWidth( unsigned char c ) const = 0;
// Peter Petrov 20 March 2009
/** Retrieve the width of the given character in PDF units in the current font
* \param c character
* \returns the width in PDF units
*/
virtual double UnicodeCharWidth( unsigned short c ) const = 0;
/** Retrieve the width of the given character in 1/1000th mm in the current font
* \param c character
* \returns the width in 1/1000th mm
*/
inline unsigned long CharWidthMM( unsigned char c ) const;
/** Retrieve the line spacing for this font
* \returns the linespacing in PDF units
*/
virtual double GetLineSpacing() const = 0;
/** Retrieve the line spacing for this font
* \returns the linespacing in 1/1000th mm
*/
inline unsigned long GetLineSpacingMM() const;
/** Get the width of the underline for the current
* font size in PDF units
* \returns the thickness of the underline in PDF units
*/
virtual double GetUnderlineThickness() const = 0;
/** Get the width of the underline for the current
* font size in 1/1000th mm
* \returns the thickness of the underline in 1/1000th mm
*/
inline unsigned long GetUnderlineThicknessMM() const;
/** Return the position of the underline for the current font
* size in PDF units
* \returns the underline position in PDF units
*/
virtual double GetUnderlinePosition() const = 0;
/** Return the position of the underline for the current font
* size in 1/1000th mm
* \returns the underline position in 1/1000th mm
*/
inline long GetUnderlinePositionMM() const;
/** Return the position of the strikeout for the current font
* size in PDF units
* \returns the underline position in PDF units
*/
virtual double GetStrikeOutPosition() const = 0;
/** Return the position of the strikeout for the current font
* size in 1/1000th mm
* \returns the underline position in 1/1000th mm
*/
inline unsigned long GetStrikeOutPositionMM() const;
/** Get the width of the strikeout for the current
* font size in PDF units
* \returns the thickness of the strikeout in PDF units
*/
virtual double GetStrikeoutThickness() const = 0;
/** Get the width of the strikeout for the current
* font size in 1/1000th mm
* \returns the thickness of the strikeout in 1/1000th mm
*/
inline unsigned long GetStrikeoutThicknessMM() const;
/** Get a pointer to the path of the font file.
* \returns a zero terminated string containing the filename of the font file
*/
inline const char* GetFilename() const;
/** Get a pointer to the actual font data - if it was loaded from memory.
* \returns a binary buffer of data containing the font data
*/
virtual const char* GetFontData() const = 0;
/** Get the length of the actual font data - if it was loaded from memory.
* \returns a the length of the font data
*/
virtual pdf_long GetFontDataLen() const = 0;
/** Get a string with the postscript name of the font.
* \returns the postscript name of the font or NULL string if no postscript name is available.
*/
virtual const char* GetFontname() const = 0;
/**
* \returns NULL or a 6 uppercase letter and "+" sign prefix
* used for font subsets
*/
inline const char* GetSubsetFontnamePrefix() const;
/** Get the weight of this font.
* Used to build the font dictionay
* \returns the weight of this font (500 is normal).
*/
virtual unsigned int GetWeight() const = 0;
/** Get the ascent of this font in PDF
* units for the current font size.
*
* \returns the ascender for this font
*
* \see GetPdfAscent
*/
virtual double GetAscent() const = 0;
/** Get the ascent of this font
* Used to build the font dictionay
* \returns the ascender for this font
*
* \see GetAscent
*/
virtual double GetPdfAscent() const = 0;
/** Get the descent of this font in PDF
* units for the current font size.
* This value is usually negative!
*
* \returns the descender for this font
*
* \see GetPdfDescent
*/
virtual double GetDescent() const = 0;
/** Get the descent of this font
* Used to build the font dictionay
* \returns the descender for this font
*
* \see GetDescent
*/
virtual double GetPdfDescent() const = 0;
/** Get the italic angle of this font.
* Used to build the font dictionay
* \returns the italic angle of this font.
*/
virtual int GetItalicAngle() const = 0;
/** Set the font size of this metrics object for width and height
* calculations.
* This is typically called from PdfFont for you.
*
* \param fSize font size in points
*/
inline void SetFontSize( float fSize );
/** Retrieve the current font size of this metrics object
* \returns the current font size
*/
inline float GetFontSize() const;
/** Set the horizontal scaling of the font for compressing (< 100) and expanding (>100)
* This is typically called from PdfFont for you.
*
* \param fScale scaling in percent
*/
inline void SetFontScale( float fScale );
/** Retrieve the current horizontal scaling of this metrics object
* \returns the current font scaling
*/
inline float GetFontScale() const;
/** Set the character spacing of this metrics object
* \param fCharSpace character spacing in percent
*/
inline void SetFontCharSpace( float fCharSpace );
/** Retrieve the current character spacing of this metrics object
* \returns the current font character spacing
*/
inline float GetFontCharSpace() const;
/**
* \returns the fonttype of the loaded font
*/
inline EPdfFontType GetFontType() const;
/** Get the glyph id for a unicode character
* in the current font.
*
* \param lUnicode the unicode character value
* \returns the glyhph id for the character or 0 if the glyph was not found.
*/
virtual long GetGlyphId( long lUnicode ) const = 0;
/** Symbol fonts do need special treatment in a few cases.
* Use this method to check if the current font is a symbol
* font. Symbold fonts are detected by checking
* if they use FT_ENCODING_MS_SYMBOL as internal encoding.
*
* \returns true if this is a symbol font
*/
virtual bool IsSymbol() const = 0;
/** Try to detect the internal fonttype from
* the file extension of a fontfile.
*
* \param pszFilename must be the filename of a font file
*
* \return font type
*/
static EPdfFontType FontTypeFromFilename( const char* pszFilename );
protected:
/**
* Set the fonttype.
* \param eFontType fonttype
*/
inline void SetFontType(EPdfFontType eFontType);
protected:
std::string m_sFilename;
float m_fFontSize;
float m_fFontScale;
float m_fFontCharSpace;
std::vector<double> m_vecWidth;
EPdfFontType m_eFontType;
std::string m_sFontSubsetPrefix;
};
// -----------------------------------------------------
//
// -----------------------------------------------------
unsigned long PdfFontMetrics::CharWidthMM( unsigned char c ) const
{
return static_cast<unsigned long>(this->CharWidth( c ) / PODOFO_CONVERSION_CONSTANT);
}
// -----------------------------------------------------
//
// -----------------------------------------------------
double PdfFontMetrics::StringWidth( const PdfString & rsString ) const
{
return (rsString.IsUnicode() ? this->StringWidth( rsString.GetUnicode() ) : this->StringWidth( rsString.GetString() ));
}
// -----------------------------------------------------
//
// -----------------------------------------------------
unsigned long PdfFontMetrics::StringWidthMM( const char* pszText, unsigned int nLength ) const
{
return static_cast<unsigned long>(this->StringWidth( pszText, nLength ) / PODOFO_CONVERSION_CONSTANT);
}
// -----------------------------------------------------
//
// -----------------------------------------------------
unsigned long PdfFontMetrics::StringWidthMM( const pdf_utf16be* pszText, unsigned int nLength ) const
{
return static_cast<unsigned long>(this->StringWidth( pszText, nLength ) / PODOFO_CONVERSION_CONSTANT);
}
// -----------------------------------------------------
//
// -----------------------------------------------------
#ifndef _WCHAR_T_DEFINED
#if defined(_MSC_VER) && _MSC_VER <= 1200 // nicht für Visualstudio 6
#else
unsigned long PdfFontMetrics::StringWidthMM( const wchar_t* pszText, unsigned int nLength ) const
{
return static_cast<unsigned long>(this->StringWidth( pszText, nLength ) / PODOFO_CONVERSION_CONSTANT);
}
#endif
#endif
// -----------------------------------------------------
//
// -----------------------------------------------------
unsigned long PdfFontMetrics::GetLineSpacingMM() const
{
return static_cast<unsigned long>(this->GetLineSpacing() / PODOFO_CONVERSION_CONSTANT);
}
// -----------------------------------------------------
//
// -----------------------------------------------------
long PdfFontMetrics::GetUnderlinePositionMM() const
{
return static_cast<long>(this->GetUnderlinePosition() / PODOFO_CONVERSION_CONSTANT);
}
// -----------------------------------------------------
//
// -----------------------------------------------------
unsigned long PdfFontMetrics::GetStrikeOutPositionMM() const
{
return static_cast<long>(this->GetStrikeOutPosition() / PODOFO_CONVERSION_CONSTANT);
}
// -----------------------------------------------------
//
// -----------------------------------------------------
unsigned long PdfFontMetrics::GetUnderlineThicknessMM() const
{
return static_cast<unsigned long>(this->GetUnderlineThickness() / PODOFO_CONVERSION_CONSTANT);
}
// -----------------------------------------------------
//
// -----------------------------------------------------
unsigned long PdfFontMetrics::GetStrikeoutThicknessMM() const
{
return static_cast<unsigned long>(this->GetStrikeoutThickness() / PODOFO_CONVERSION_CONSTANT);
}
// -----------------------------------------------------
//
// -----------------------------------------------------
const char* PdfFontMetrics::GetFilename() const
{
return m_sFilename.c_str();
}
// -----------------------------------------------------
//
// -----------------------------------------------------
EPdfFontType PdfFontMetrics::GetFontType() const
{
return m_eFontType;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfFontMetrics::SetFontType(EPdfFontType eFontType)
{
m_eFontType = eFontType;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
float PdfFontMetrics::GetFontSize() const
{
return m_fFontSize;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfFontMetrics::SetFontSize( float fSize )
{
m_fFontSize = fSize;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
float PdfFontMetrics::GetFontScale() const
{
return m_fFontScale;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
float PdfFontMetrics::GetFontCharSpace() const
{
return m_fFontCharSpace;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
const char* PdfFontMetrics::GetSubsetFontnamePrefix() const
{
return m_sFontSubsetPrefix.c_str();
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfFontMetrics::SetFontScale( float fScale )
{
m_fFontScale = fScale;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfFontMetrics::SetFontCharSpace( float fCharSpace )
{
m_fFontCharSpace = fCharSpace;
}
};
#endif // _PDF_FONT_METRICS_H_
|