Foxit PDF SDK
fs_compliancecommon.h
Go to the documentation of this file.
1 
16 #ifndef FS_COMPLIANCEENGINE_H_
17 #define FS_COMPLIANCEENGINE_H_
18 
19 #include "common/fs_common.h"
20 
26 namespace foxit {
30 namespace addon {
34 namespace compliance {
44 class ComplianceEngine FS_FINAL : public Object{
45  public:
78  static ErrorCode Initialize(const wchar_t* compliance_resource_folder_path, const char* compliance_engine_unlockcode);
79 
88  static void Release();
89 
90 #if !defined(_MAC_JAVA_)
91 
113 
123  static void ReleaseThreadContext();
124 #endif
125 
138  static void SetTempFolderPath(const wchar_t* temp_folder_path);
139 
156  static void SetLanguage(const char* language);
157 };
158 
164  public:
170  virtual void Release() = 0;
171 
180  virtual void UpdateCurrentStateData(int current_rate, const WString& current_state_string) = 0;
181 
182  protected:
183  ~ProgressCallback() {}
184 };
185 
189 class FixupData : public Object {
190  public:
196  typedef enum _FixupState {
203  } FixupState;
204 
205 
208  : used_count(0)
210 
216  FixupData(const FixupData& other)
217  : used_count(other.used_count)
218  , state(other.state)
219  , name(other.name)
220  , comment(other.comment)
221  , reasons(other.reasons) {}
222 
230  FixupData& operator = (const FixupData& other) {
231  used_count = other.used_count;
232  state = other.state;
233  name = other.name;
234  comment = other.comment;
235  reasons = other.reasons;
236  return *this;
237  }
238 
246  bool operator == (const FixupData& other) const {
247  bool is_equal = (used_count == other.used_count && state == other.state &&
248  name == other.name && comment == other.comment);
249  if (is_equal) {
250  for (int i=0; i<(int)reasons.GetSize(); i++) {
251  if (reasons[i] != other.reasons[i]) {
252  is_equal = false;
253  break;
254  }
255  }
256  }
257  return is_equal;
258  }
259 
267  bool operator != (const FixupData& other) const {
268  return !((*this) == other);
269  }
270 
284 };
285 
289 class HitData : public Object {
290  public:
296  typedef enum _CheckSeverity {
303  } CheckSeverity;
304 
305 
308  : triggered_count(0)
310  , page_index(-1){}
311 
317  HitData(const HitData& other)
319  , severity(other.severity)
320  , name(other.name)
321  , comment(other.comment)
323  , page_index(other.page_index) {}
324 
332  HitData& operator = (const HitData& other) {
334  severity = other.severity;
335  name = other.name;
336  comment = other.comment;
338  page_index = other.page_index;
339  return *this;
340  }
341 
349  bool operator == (const HitData& other) const {
350  bool is_equal = (triggered_count == other.triggered_count && severity == other.severity &&
351  name == other.name && comment == other.comment && page_index == other.page_index);
352  if (is_equal) {
353  for (int i=0; i<(int)trigger_values.GetSize(); i++) {
354  if (trigger_values[i] != other.trigger_values[i]) {
355  is_equal = false;
356  break;
357  }
358  }
359  }
360  return is_equal;
361  }
362 
370  bool operator != (const HitData& other) const {
371  return !((*this) == other);
372  }
373 
389 };
390 
395 class ResultInformation FS_FINAL : public Base {
396  public:
399  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
400  explicit ResultInformation(FS_HANDLE handle);
408  ResultInformation(const ResultInformation& other);
409 
425  bool operator == (const ResultInformation& other) const;
426 
434  bool operator != (const ResultInformation& other) const;
435 
443  bool IsEmpty() const;
444 
450  int GetFixupDataCount() const;
459  FixupData GetFixupData(int index) const;
460 
466  int GetHitDataCount() const;
475  HitData GetHitData(int index) const;
476 };
477 
478 } // namespace compliance
479 } // namespace addon
480 } // namespace foxit
481 
482 #endif // FS_COMPLIANCEENGINE_H_
483 
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
foxit::addon::compliance::HitData::e_CheckSeverityInfo
Info severity.
Definition: fs_compliancecommon.h:298
foxit::addon::compliance::HitData::severity
CheckSeverity severity
The check severity of current hit data. Please refer to values starting from HitData::e_CheckSeverity...
Definition: fs_compliancecommon.h:380
foxit::addon::compliance::FixupData::FixupData
FixupData(const FixupData &other)
Constructor, with another fixup data object.
Definition: fs_compliancecommon.h:216
foxit::addon::compliance::ResultInformation::ResultInformation
ResultInformation()
Constructor.
foxit::Object
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
foxit::addon::compliance::HitData::HitData
HitData()
Constructor.
Definition: fs_compliancecommon.h:307
fs_common.h
Header file for common definitions and classes.
foxit::addon::compliance::HitData::operator==
bool operator==(const HitData &other) const
Equal operator.
Definition: fs_compliancecommon.h:349
foxit::addon::compliance::ResultInformation::GetFixupData
FixupData GetFixupData(int index) const
Get a fixup data.
foxit::addon::compliance::HitData::e_CheckSeverityWarning
Warning severity.
Definition: fs_compliancecommon.h:300
foxit::ErrorCode
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:237
foxit::addon::compliance::HitData::operator!=
bool operator!=(const HitData &other) const
Not equal operator.
Definition: fs_compliancecommon.h:370
foxit::addon::compliance::FixupData::operator==
bool operator==(const FixupData &other) const
Equal operator.
Definition: fs_compliancecommon.h:246
foxit::addon::compliance::HitData::triggered_count
uint32 triggered_count
Represents how many times the hit operation for current data has been triggered during verifying or c...
Definition: fs_compliancecommon.h:375
foxit::addon::compliance::ComplianceEngine::SetLanguage
static void SetLanguage(const char *language)
Set language for compliance engine.
foxit::addon::compliance::HitData::page_index
int page_index
Page index, starting from 0. -1 means current hit data was hit in document level.
Definition: fs_compliancecommon.h:388
foxit::addon::compliance::FixupData::name
WString name
Fixup rule name.
Definition: fs_compliancecommon.h:279
foxit::addon::compliance::FixupData::operator=
FixupData & operator=(const FixupData &other)
Assign operator.
Definition: fs_compliancecommon.h:230
foxit::addon::compliance::HitData
Definition: fs_compliancecommon.h:289
foxit::addon::compliance::HitData::e_CheckSeverityError
Error severity.
Definition: fs_compliancecommon.h:302
foxit::addon::compliance::HitData::trigger_values
WStringArray trigger_values
Array of trigger values. The count of triggered values is no more then triggered_count.
Definition: fs_compliancecommon.h:386
foxit::addon::compliance::ComplianceEngine::InitializeThreadContext
static ErrorCode InitializeThreadContext()
Initialize compliance context for a new thread.
foxit::addon::compliance::FixupData::used_count
uint32 used_count
Represents how many times the fixup operation for current data has been triggered during converting p...
Definition: fs_compliancecommon.h:272
foxit::addon::compliance::ResultInformation
Definition: fs_compliancecommon.h:395
foxit::addon::compliance::HitData::operator=
HitData & operator=(const HitData &other)
Assign operator.
Definition: fs_compliancecommon.h:332
foxit::addon::compliance::ComplianceEngine::Initialize
static ErrorCode Initialize(const wchar_t *compliance_resource_folder_path, const char *compliance_engine_unlockcode)
Initialize compliance engine.
foxit::addon::compliance::ResultInformation::~ResultInformation
~ResultInformation()
Destructor.
foxit::addon::compliance::ResultInformation::operator!=
bool operator!=(const ResultInformation &other) const
Not equal operator.
foxit::addon::compliance::FixupData::state
FixupState state
Fixup state. Please refer to values starting from FixupData::e_FixupStateSuccess and this should be o...
Definition: fs_compliancecommon.h:277
foxit::addon::compliance::FixupData::reasons
WStringArray reasons
Fixup reasons. This may be an empty array. The count of reasons is no more then used_times.
Definition: fs_compliancecommon.h:283
foxit::addon::compliance::FixupData::e_FixupStateNotRequired
A fixup was not required.
Definition: fs_compliancecommon.h:202
foxit::WStringArray::GetSize
size_t GetSize() const
Get the size of elements in current array.
foxit::addon::compliance::ResultInformation::operator==
bool operator==(const ResultInformation &other) const
Equal operator.
foxit::addon::compliance::ResultInformation::GetHitData
HitData GetHitData(int index) const
Get a hit data.
foxit::addon::compliance::FixupData::FixupState
FixupState
Enumeration for the state of a fixup data.
Definition: fs_compliancecommon.h:196
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::addon::compliance::HitData::HitData
HitData(const HitData &other)
Constructor, with another hit data object.
Definition: fs_compliancecommon.h:317
foxit::addon::compliance::HitData::CheckSeverity
CheckSeverity
Enumeration for check severity of a hit data.
Definition: fs_compliancecommon.h:296
foxit::addon::compliance::ResultInformation::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::addon::compliance::HitData::comment
WString comment
Hit rule comment to explain more details about the rule.
Definition: fs_compliancecommon.h:384
foxit::addon::compliance::ComplianceEngine::Release
static void Release()
Release compliance engine.
foxit::addon::compliance::ProgressCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::addon::compliance::FixupData::e_FixupStateSuccess
A fixup succeeded.
Definition: fs_compliancecommon.h:198
foxit::addon::compliance::ResultInformation::operator=
ResultInformation & operator=(const ResultInformation &other)
Assign operator.
foxit::addon::compliance::ComplianceEngine::SetTempFolderPath
static void SetTempFolderPath(const wchar_t *temp_folder_path)
Set a temp folder for compliance engine.
foxit::WStringArray
Definition: fs_basictypes.h:228
foxit::addon::compliance::ComplianceEngine
Definition: fs_compliancecommon.h:44
foxit::addon::compliance::ProgressCallback::UpdateCurrentStateData
virtual void UpdateCurrentStateData(int current_rate, const WString &current_state_string)=0
A callback function used to update current progress state data to user in order that user can update ...
foxit::addon::compliance::FixupData
Definition: fs_compliancecommon.h:189
foxit::addon::compliance::FixupData::operator!=
bool operator!=(const FixupData &other) const
Not equal operator.
Definition: fs_compliancecommon.h:267
foxit::addon::compliance::ProgressCallback
Definition: fs_compliancecommon.h:163
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1452
foxit::addon::compliance::FixupData::FixupData
FixupData()
Constructor.
Definition: fs_compliancecommon.h:207
foxit::addon::compliance::ResultInformation::GetFixupDataCount
int GetFixupDataCount() const
Get count of fixup data.
foxit::addon::compliance::HitData::name
WString name
Hit rule name.
Definition: fs_compliancecommon.h:382
foxit::addon::compliance::FixupData::comment
WString comment
Fixup rule comment to explain more details about the rule.
Definition: fs_compliancecommon.h:281
foxit::addon::compliance::ResultInformation::GetHitDataCount
int GetHitDataCount() const
Get count of hit data.
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
foxit::Base
Definition: fs_basictypes.h:427
foxit::addon::compliance::FixupData::e_FixupStateFailure
A fixup failed.
Definition: fs_compliancecommon.h:200
foxit::addon::compliance::ComplianceEngine::ReleaseThreadContext
static void ReleaseThreadContext()
Release compliance context of the thread.