Foxit PDF SDK
fs_basictypes.h
Go to the documentation of this file.
1 
16 #ifndef FS_BASIC_TYPES_H_
17 #define FS_BASIC_TYPES_H_
18 
19 #include <cstddef>
20 #include <fstream>
21 #include <iostream>
22 #include <string>
23 #include <memory>
24 #include <vector>
25 #include <exception>
26 #include <cmath>
27 #include <cfloat>
28 #include <stdlib.h>
29 #include <string.h>
30 
31 #include "common/fxcrt/fx_basic.h"
34 
35 #if defined(_WIN32) || defined(_WIN64)
36 #include <Windows.h>
37 #endif // defined(_WIN32) || defined(_WIN64)
38 
39 #define FSDK_DEFINE_ARRAY(ArrayName, Type) \
40 class ArrayName : public Object { \
41  public: \
42 \
43  ArrayName(); \
44 \
45  ~ArrayName(); \
46 \
50  ArrayName(const ArrayName& other); \
51 \
56  ArrayName& operator = (const ArrayName& other); \
57 \
61  size_t GetSize() const; \
62 \
67  Type GetAt(size_t index) const; \
68 \
73  Type& operator[](size_t index) const; \
74 \
79  void Add(const Type& element); \
80 \
86  void RemoveAt(size_t index); \
87 \
94  void InsertAt(size_t index, const Type& element); \
95 \
99  void RemoveAll(); \
100  \
101  private: \
102  void* data_; \
103 };
104 
105 namespace std {
106 class exception;
107 }
108 
116 inline CFX_ByteString FX_UTF8Encode(const wchar_t* wstr) {
118 }
119 
128 inline bool operator==(const char* str1, const CFX_ByteString& str2) {
129  return str2.Equal(str1);
130 }
131 
140 inline bool operator!=(const char* str1, const CFX_ByteString& str2) {
141  return !str2.Equal(str1);
142 }
143 
152 inline std::ostream& operator<<(std::ostream& os, const CFX_ByteString& str) {
153  return os << (const char*) str;
154 }
155 
164 inline std::wostream& operator<<(std::wostream& os, const CFX_WideString& str) {
165  return os << (const wchar_t*) str;
166 }
167 
168 #ifndef TRUE
169 
170 #define TRUE true
171 #endif
172 
173 #ifndef FALSE
174 
175 #define FALSE false
176 #endif
177 
178 #ifndef NULL
179 
180 #define NULL ((void*)0)
181 #endif
182 
188 namespace foxit {
190 typedef FX_INT64 int64;
192 typedef FX_UINT64 uint64;
194 typedef FX_INT32 int32;
198 typedef FX_INT16 int16;
202 typedef FX_INT8 int8;
204 typedef FX_UINT8 uint8;
210 typedef uint32 ARGB;
212 typedef uint32 RGB;
214 typedef void* FS_HANDLE;
215 
216 #if defined(_WIN32) || defined(_WIN64)
217 
218 typedef void* FX_HWND;
219 #endif
220 
221 typedef CFX_Object Object;
226 
228 FSDK_DEFINE_ARRAY(WStringArray, WString)
230 FSDK_DEFINE_ARRAY(StringArray, String)
231 
237 typedef enum _ErrorCode {
438 } ErrorCode;
439 
440 
447 
449 class Base : public Object {
450  public:
456  FS_HANDLE Handle() const {
457  return handle_;
458  }
459  virtual ~Base(){}
460 
461  protected:
462  explicit Base(FS_HANDLE handle = NULL) : handle_(handle) {}
463  FS_HANDLE handle_;
464 };
465 
471 typedef PointF Offset;
475 typedef FX_RECT RectI;
480 
482 class DateTime : public Object {
483  public:
489  static DateTime GetUTCTime();
495  static DateTime GetLocalTime();
496 
517  : year(year)
518  , month(month)
519  , day(day)
520  , hour(hour)
521  , minute(minute)
522  , second(second)
526 
529  : year(0)
530  , month(0)
531  , day(0)
532  , hour(0)
533  , minute(0)
534  , second(0)
535  , milliseconds(0)
536  , utc_hour_offset(0)
537  , utc_minute_offset(0) {}
543  explicit DateTime(const FXCRT_DATETIMEZONE& time);
549  DateTime(const DateTime& dt)
550  : year(dt.year)
551  , month(dt.month)
552  , day(dt.day)
553  , hour(dt.hour)
554  , minute(dt.minute)
555  , second(dt.second)
559 
568  year = dt.year;
569  month = dt.month;
570  day = dt.day;
571  hour = dt.hour;
572  minute = dt.minute;
573  second = dt.second;
577  return *this;
578  }
580  operator FXCRT_DATETIMEZONE() const;
581 
582 #if (defined(_WIN32) || defined(_WIN64)) && !defined(SWIG)
583 
588  explicit DateTime(const SYSTEMTIME& systime)
589  : year(systime.wYear)
590  , month(systime.wMonth)
591  , day(systime.wDay)
592  , hour(systime.wHour)
593  , minute(systime.wMinute)
594  , second(systime.wSecond)
595  , milliseconds(systime.wMilliseconds)
596  , utc_hour_offset(0)
597  , utc_minute_offset(0) {}
598 
600  operator SYSTEMTIME() const;
601 #endif // defined(_WIN32) || defined(_WIN64)
602 
625  this->year = year;
626  this->month = month;
627  this->day = day;
628  this->hour = hour;
629  this->minute = minute;
630  this->second = second;
631  this->milliseconds = milliseconds;
632  this->utc_hour_offset = utc_hour_offset;
633  this->utc_minute_offset = utc_minute_offset;
634  }
635 
643  bool IsValid() const;
644 
652  bool operator == (const DateTime& datetime) const;
660  bool operator != (const DateTime& datetime) const;
668  bool operator > (const DateTime& datetime) const;
678  bool operator >= (const DateTime& datetime) const;
686  bool operator < (const DateTime& datetime) const;
697  bool operator <= (const DateTime& datetime) const;
698 
705 
711  DateTime& ToUTCTime();
712 
736 
739 
740 };
741 
742 //#if !defined(_SWIG_ANDROID_) && !defined(_SWIG_IOS_)
743 
745 class Exception : public std::exception , public Object {
746  public:
757  Exception(const char* file_name, int line_number, const char* function_name, ErrorCode error_code);
758 
764  Exception(const Exception& exception)
765  : error_code_(exception.error_code_)
766  , error_message_(exception.error_message_)
767  , name_(exception.name_) {}
768 
776  Exception& operator = (const Exception& exception) {
777  error_code_ = exception.error_code_;
778  error_message_ = exception.error_message_;
779  return *this;
780  }
781 
783  ~Exception() throw() {}
784 
791  return error_code_;
792  }
793 
800  {
801  return error_message_;
802  }
803 
809  String GetName() const
810  { return name_; }
811 
812  private:
813  ErrorCode error_code_;
814  String error_message_;
815  String name_;
816 };
817 
818 #define throw(Exception)
819 //#endif // !defined(_SWIG_ANDROID_) && !defined(_SWIG_IOS_)
820 
821 #if __cpluscplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1700)
822 #define FS_FINAL final
823 #else
824 #define FS_FINAL
825 #endif
826 
827 #if __cpluscplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1600)
828 #define FS_OVERRIDE override
829 #else
830 #define FS_OVERRIDE
831 #endif
832 
833 } // namespace foxit
834 #endif
DateTime & operator=(const DateTime &dt)
Assign operator.
Definition: fs_basictypes.h:567
Invalid or incorrect state.
Definition: fs_basictypes.h:290
ErrorCode GetErrCode() const
Get the error code.
Definition: fs_basictypes.h:790
int16 utc_hour_offset
Hour of time zone. Valid range: from -12 to 12.
Definition: fs_basictypes.h:735
String GetMessage() const
Get the error message string.
Definition: fs_basictypes.h:799
Invalid password. Usually, this error may occur when loading a PDF document with password....
Definition: fs_basictypes.h:248
(For compliance only) Compliance resource file(s) cannot be found or opened. Please check if complian...
Definition: fs_basictypes.h:361
DateTime & ToLocalTime()
Convert current object to local time.
No "Conversion" module right.
Definition: fs_basictypes.h:383
(For ConnectedPDF only) Cannot set the ACL to ConnectedPDF server.
Definition: fs_basictypes.h:308
(For ConnectedPDF only) Cannot get client ID from ConnectedPDF server.
Definition: fs_basictypes.h:320
PointF Offset
Offset information, in float.
Definition: fs_basictypes.h:471
Format is invalid. For files, this may also mean that file is corrupted.
Definition: fs_basictypes.h:243
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
(For compliance only) Invalid unlock code is used to initialize compliance engine.
Definition: fs_basictypes.h:338
DateTime(const DateTime &dt)
Constructor, with another date and time object.
Definition: fs_basictypes.h:549
uint16 minute
Minute. Valid range: from 0 to 59.
Definition: fs_basictypes.h:722
No "TableMaker" module right.
Definition: fs_basictypes.h:401
(For compliance only) Fail to initialize compliance engine.
Definition: fs_basictypes.h:340
void Set(uint16 year, uint16 month, uint16 day, uint16 hour, uint16 minute, uint16 second, uint16 milliseconds, int16 utc_hour_offset, uint16 utc_minute_offset)
Set value.
Definition: fs_basictypes.h:622
(For LTV only) Fail to check DTS.
Definition: fs_basictypes.h:350
No "RMS" module right.
Definition: fs_basictypes.h:373
FX_DWORD FX_UINT32
unsigned 32bits integer.
Definition: fx_system.h:767
Data of current object is invalid.
Definition: fs_basictypes.h:284
wchar_t const * FX_LPCWSTR
Pointer to constant Unicode characters.
Definition: fx_system.h:736
No "Office2PDF" module right.
Definition: fs_basictypes.h:421
FX_UINT8 uint8
8-bit unsigned integer.
Definition: fs_basictypes.h:204
Definition: fs_basictypes.h:228
Definition: fs_basictypes.h:482
(For OCR only) Not enough disk space.
Definition: fs_basictypes.h:330
bool operator<(const DateTime &datetime) const
Smaller operator.
File or folder path does not exist.
Definition: fs_basictypes.h:334
uint16 hour
Hour. Valid range: from 0 to 23.
Definition: fs_basictypes.h:720
No "PDF2Office" module right.
Definition: fs_basictypes.h:407
DateTime(uint16 year, uint16 month, uint16 day, uint16 hour, uint16 minute, uint16 second, uint16 milliseconds, int16 utc_hour_offset, uint16 utc_minute_offset)
Constructor, with parameters.
Definition: fs_basictypes.h:514
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
uint16 milliseconds
Millisecond. Valid range: from 0 to 999. PDF standard does not support now, this can be omitted if it...
Definition: fs_basictypes.h:729
Definition: fx_coordinates.h:30
(For ConnectedPDF only) The input ConnectedPDF DRM wrapper document is invalid.
Definition: fs_basictypes.h:318
uint16 year
Year. It should be a four-digit number, such as 2014.
Definition: fs_basictypes.h:714
No default server has been set to time stamp server manager yet.
Definition: fs_basictypes.h:363
No "XFA" module right.
Definition: fs_basictypes.h:369
MIP engine: get extended label information by id failed.
Definition: fs_basictypes.h:429
File cannot be found or could not be opened.
Definition: fs_basictypes.h:241
(For ConnectedPDF only) Cannot connect to ConnectedPDF server.
Definition: fs_basictypes.h:294
uint16 month
Month. Valid range: from 1 to 12.
Definition: fs_basictypes.h:716
(For LTV only) Fail to load DSS.
Definition: fs_basictypes.h:352
Error handle.
Definition: fs_basictypes.h:250
PDF document is encrypted by some unsupported security handler.
Definition: fs_basictypes.h:267
No "Compliance" module right.
Definition: fs_basictypes.h:379
Exception & operator=(const Exception &exception)
Assign operator.
Definition: fs_basictypes.h:776
WIDE STRING CLASS.
Definition: fx_string.h:1461
std::ostream & operator<<(std::ostream &os, const CFX_ByteString &str)
Output byte string to std::ostream.
Definition: fs_basictypes.h:152
CFX_WideString WString
Wide string.
Definition: fs_basictypes.h:223
MIP engine: add upe engine failed.
Definition: fs_basictypes.h:425
void * FX_POSITION
A value used to denote the position of an element in a collection.
Definition: fx_system.h:658
No "AdvEdit" module right.
Definition: fs_basictypes.h:405
Cannot use current default time stamp server. Please check if default time stamp server can be used.
Definition: fs_basictypes.h:365
(For ConnectedPDF only) Current user has no right to open the ConnectedPDF DRM document.
Definition: fs_basictypes.h:298
No "3D" module right.
Definition: fs_basictypes.h:415
FX_UINT64 uint64
Unsigned 64-bit integer.
Definition: fs_basictypes.h:192
(For ConnectedPDF only) The loaded document is not a ConnectedPDF DRM document.
Definition: fs_basictypes.h:292
No "LayoutRecognition" module right.
Definition: fs_basictypes.h:391
(For ConnectedPDF only) Cannot get user token from ConnectedPDF server.
Definition: fs_basictypes.h:322
bool operator==(const DateTime &datetime) const
Equal operator.
(For ConnectedPDF only) There is some error in response data.
Definition: fs_basictypes.h:433
uint16 day
Day of month. Valid range: from 1 to 31.
Definition: fs_basictypes.h:718
(For OCR only) OCR engine has not been initialized successfully.
Definition: fs_basictypes.h:328
Structure for date and time.
Definition: fx_process.h:95
Definition: fs_basictypes.h:745
(For Office-to-PDF conversion only) No Microsoft Office is installed in current system.
Definition: fs_basictypes.h:387
No "Optimizer" module right.
Definition: fs_basictypes.h:381
Parameter error: value of any input parameter for a function is invalid.
Definition: fs_basictypes.h:261
static DateTime GetUTCTime()
Get UTC time.
Current object has not been loaded yet.
Definition: fs_basictypes.h:288
(For DWG-to-PDF conversion only) ODA engine is not found.
Definition: fs_basictypes.h:399
No "ConnectedPDF" module right.
Definition: fs_basictypes.h:367
Invalid license is used to initialize Foxit PDF SDK library.
Definition: fs_basictypes.h:259
int FX_INT32
32-bit signed integer.
Definition: fx_system.h:683
bool operator >(const DateTime &datetime) const
Greater operator.
(For ConnectedPDF only) Cannot remove the security from ConnectedPDF server.
Definition: fs_basictypes.h:304
int FX_STRSIZE
String size is limited to 2^31-1.
Definition: fx_string.h:35
(For OFD only) OFD engine has not been initialized successfully.
Definition: fs_basictypes.h:411
FS_HANDLE Handle() const
Get the handle of current object.
Definition: fs_basictypes.h:456
(For ConnectedPDF only) Input ACL is invalid.
Definition: fs_basictypes.h:324
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
(For Office-to-PDF conversion only) Office COM has not been initialized successfully.
Definition: fs_basictypes.h:385
The type of input object or current object is invalid.
Definition: fs_basictypes.h:273
(For converting html to pdf only) The converted URL is on blacklist.
Definition: fs_basictypes.h:409
No "DWG2PDF" module right.
Definition: fs_basictypes.h:403
(For ConnectedPDF only) Cannot upload ConnectedPDF DRM document info to ConnectedPDF server.
Definition: fs_basictypes.h:316
Data is not ready. Usually this is used as an exception error code when loading document in asynchron...
Definition: fs_basictypes.h:282
Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet.
Definition: fs_basictypes.h:269
Certificate error: PDF document is encrypted by digital certificate but current user does not have th...
Definition: fs_basictypes.h:255
CFX_FloatRect RectF
Rectangle, in float.
Definition: fs_basictypes.h:473
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
#define FXSYS_wcslen
Get the length of a wide-character string.
Definition: fx_system.h:1028
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:237
CFX_ByteString FX_UTF8Encode(const wchar_t *wstr)
Convert wide string to UTF-8 encoding byte string.
Definition: fs_basictypes.h:116
signed char FX_INT8
Signed 8bits integer.
Definition: fx_system.h:661
CFX_PointF PointF
Point information, in float.
Definition: fs_basictypes.h:469
(For ConnectedPDF only) Loaded document is already a ConnectedPDF document.
Definition: fs_basictypes.h:310
(For Office-to-PDF conversion only) WPS office engine is not found.
Definition: fs_basictypes.h:393
CFX_ArrayTemplate< int32 > Int32Array
An array of signed integer values.
Definition: fs_basictypes.h:444
(For ConnectedPDF only) Loaded document is already a ConnectedPDF DRM document.
Definition: fs_basictypes.h:312
Any unknown state occurs.
Definition: fs_basictypes.h:277
(For ConnectedPDF only) Current device is limited to open the ConnectedPDF DRM document.
Definition: fs_basictypes.h:302
bool operator<=(const DateTime &datetime) const
Smaller or equal operator.
Time stamp server manager has not been initialized successfully.
Definition: fs_basictypes.h:342
bool operator >=(const DateTime &datetime) const
Greater or equal operator.
No "OCR" module right.
Definition: fs_basictypes.h:375
FX_POSITION POSITION
A value used to denote the position of an element in a collection.
Definition: fs_basictypes.h:206
Exception(const char *file_name, int line_number, const char *function_name, ErrorCode error_code)
Constructor, with parameters.
MIP engine: add upe engine failed.
Definition: fs_basictypes.h:423
FX_INT64 int64
Signed 64-bit integer.
Definition: fs_basictypes.h:190
(For PDF Optimizer PDF) There are some objects not image type.
Definition: fs_basictypes.h:437
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
(For compliance only) Compliance engine has not been initialized successfully.
Definition: fs_basictypes.h:336
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:225
(For LTV only) LTV verify mode has not been set.
Definition: fs_basictypes.h:344
FX_INT64 FILESIZE
File size. Support large file directly.
Definition: fs_basictypes.h:208
Header file for Process & thread related definitions and classes.
(For ConnectedPDF only) Input client ID is invalid.
Definition: fs_basictypes.h:326
(For HTML2PDF only)Occuring timeout during loading web page.
Definition: fs_basictypes.h:435
FX_INT8 int8
8-bit signed integer.
Definition: fs_basictypes.h:202
unsigned short FX_UINT16
Unsigned 16bits integer.
Definition: fx_system.h:673
(For OCR only) The trial for OCR module is end.
Definition: fs_basictypes.h:332
(For signature only) The signature being operated needs to be signed.
Definition: fs_basictypes.h:356
CFX_ArrayTemplate< uint32 > UInt32Array
An array of unsigned integer values.
Definition: fs_basictypes.h:446
Definition: fx_coordinates.h:596
CFX_Matrix Matrix
Matrix information, in float.
Definition: fs_basictypes.h:467
DateTime()
Constructor.
Definition: fs_basictypes.h:528
unsigned char FX_UINT8
Unsigned 8bits integer.
Definition: fx_system.h:663
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
New data conflicts with existed data.
Definition: fs_basictypes.h:275
Definition: fs_basictypes.h:449
(For ConnectedPDF only) Cannot upload ConnectedPDF document info to ConnectedPDF server.
Definition: fs_basictypes.h:314
Definition: fs_basictypes.h:230
No "Accessibility" module right.
Definition: fs_basictypes.h:397
String GetName() const
Get the string of error code.
Definition: fs_basictypes.h:809
bool operator !=(const DateTime &datetime) const
Not equal operator.
uint16 second
Second. Valid range: from 0 to 60. 60 for leap second.
Definition: fs_basictypes.h:724
uint16 utc_minute_offset
Minute of time zone. Valid range: from 0 to 59.
Definition: fs_basictypes.h:738
FX_INT16 int16
16-bit signed integer.
Definition: fs_basictypes.h:198
Foxit namespace.
Definition: fs_taggedpdf.h:27
XFA loading error.
Definition: fs_basictypes.h:286
short FX_INT16
Signed 16bits integer.
Definition: fx_system.h:671
(For ConnectedPDF only) Cannot get the ACL from ConnectedPDF server.
Definition: fs_basictypes.h:306
No "Comparison" module right.
Definition: fs_basictypes.h:377
Exception(const Exception &exception)
Constructor, with another exception object.
Definition: fs_basictypes.h:764
No "OFD" module right.
Definition: fs_basictypes.h:413
Invalid regular expression.
Definition: fs_basictypes.h:417
BYTE STRING CLASS.
Definition: fx_string.h:317
FX_UINT16 uint16
16-bit unsigned integer.
Definition: fs_basictypes.h:200
(For Office-to-PDF conversion only) Libre office engine is not found.
Definition: fs_basictypes.h:395
Header file for basic data class.
static DateTime GetLocalTime()
Get local time.
(For LTV only) Fail to load DTS.
Definition: fs_basictypes.h:354
No "Print2PDF" module right.
Definition: fs_basictypes.h:431
#define NULL
The null-pointer value.
Definition: fx_system.h:792
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
CFX_ArrayTemplate< PointF > PointFArray
An array of PointF objects.
Definition: fs_basictypes.h:479
Definition: fx_coordinates.h:1076
Success, and no error occurs.
Definition: fs_basictypes.h:239
CFX_ArrayTemplate< RectF > RectFArray
An array of RectF objects.
Definition: fs_basictypes.h:477
bool Equal(FX_BSTR str) const
Check if current string is equal to another one. Case-sensitive.
Any unknown error occurs.
Definition: fs_basictypes.h:257
MIP engine: create protection handler failed.
Definition: fs_basictypes.h:427
#define FX_FILESIZE
Support large file directly.
Definition: fx_stream.h:155
Expected data or object is not found.
Definition: fs_basictypes.h:271
Header file for coordinate system.
(For ConnectedPDF only) Input user token is invalid.
Definition: fs_basictypes.h:296
No document permission to operate.
Definition: fs_basictypes.h:419
No "Redaction" module right.
Definition: fs_basictypes.h:371
(For ConnectedPDF only) The rights of Current user has expired.
Definition: fs_basictypes.h:300
(For LTV only) Revocation callback for LTV has not been set.
Definition: fs_basictypes.h:346
~Exception()
Destructor.
Definition: fs_basictypes.h:783
DateTime & ToUTCTime()
Convert current object to UTC time.
(For LTV only) Fail to switch PDF verion.
Definition: fs_basictypes.h:348
Out-of-memory error occurs.
Definition: fs_basictypes.h:265
bool IsValid() const
Check whether current object is valid or not.
CFX_ArrayTemplate< float > FloatArray
An array of float values.
Definition: fs_basictypes.h:442
(For Excel-to-PDF conversion only) Excel document does not have any content so it cannot be converted...
Definition: fs_basictypes.h:389
FX_RECT RectI
Rectangle, in integer.
Definition: fs_basictypes.h:475
Definition: fx_coordinates.h:771
Some types are not supported.
Definition: fs_basictypes.h:263