Merge to XFA: Fix ALL the include guards.
[pdfium.git] / core / include / fpdftext / fpdf_text.h
1 // Copyright 2014 PDFium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4  
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #ifndef CORE_INCLUDE_FPDFTEXT_FPDF_TEXT_H_
8 #define CORE_INCLUDE_FPDFTEXT_FPDF_TEXT_H_
9
10 #include "../fpdfapi/fpdf_page.h"
11 #include "../fpdfapi/fpdf_pageobj.h"
12 #include "../fpdfapi/fpdf_parser.h"
13
14 class CPDF_PageObjects;
15 #define PDF2TXT_AUTO_ROTATE             1
16 #define PDF2TXT_AUTO_WIDTH              2
17 #define PDF2TXT_KEEP_COLUMN             4
18 #define PDF2TXT_USE_OCR                 8
19 #define PDF2TXT_INCLUDE_INVISIBLE       16
20 void PDF_GetPageText(CFX_ByteStringArray& lines, CPDF_Document* pDoc, CPDF_Dictionary* pPage,
21                      int iMinWidth, FX_DWORD flags);
22 void PDF_GetPageText_Unicode(CFX_WideStringArray& lines, CPDF_Document* pDoc, CPDF_Dictionary* pPage,
23                              int iMinWidth, FX_DWORD flags);
24 void PDF_GetTextStream_Unicode(CFX_WideTextBuf& buffer, CPDF_Document* pDoc, CPDF_Dictionary* pPage,
25                                FX_DWORD flags);
26 CFX_WideString PDF_GetFirstTextLine_Unicode(CPDF_Document* pDoc, CPDF_Dictionary* pPage);
27 class IPDF_TextPage;
28 class IPDF_LinkExtract;
29 class IPDF_TextPageFind;
30 #define CHAR_ERROR                      -1
31 #define CHAR_NORMAL                     0
32 #define CHAR_GENERATED          1
33 #define CHAR_UNUNICODE          2
34 typedef struct {
35     FX_WCHAR                    m_Unicode;
36     FX_WCHAR                    m_Charcode;
37     FX_INT32                    m_Flag;
38     FX_FLOAT                    m_FontSize;
39     FX_FLOAT                    m_OriginX;
40     FX_FLOAT                    m_OriginY;
41     CFX_FloatRect               m_CharBox;
42     CPDF_TextObject*    m_pTextObj;
43     CFX_AffineMatrix    m_Matrix;
44 } FPDF_CHAR_INFO;
45 typedef CFX_ArrayTemplate<CFX_FloatRect> CFX_RectArray;
46 #define FPDFTEXT_LRTB   0
47 #define FPDFTEXT_RLTB   1
48 #define FPDFTEXT_TBRL   2
49 #define FPDFTEXT_LEFT                   -1
50 #define FPDFTEXT_RIGHT                  1
51 #define FPDFTEXT_UP                             -2
52 #define FPDFTEXT_DOWN                   2
53 class IPDF_ReflowedPage;
54 #define FPDFTEXT_WRITINGMODE_UNKNOW     0
55 #define FPDFTEXT_WRITINGMODE_LRTB       1
56 #define FPDFTEXT_WRITINGMODE_RLTB       2
57 #define FPDFTEXT_WRITINGMODE_TBRL       3
58 class CPDFText_ParseOptions 
59 {
60 public:
61
62     CPDFText_ParseOptions();
63     FX_BOOL                     m_bGetCharCodeOnly;
64     FX_BOOL                     m_bNormalizeObjs;
65     FX_BOOL                     m_bOutputHyphen;
66 };
67 class IPDF_TextPage 
68 {
69 public:
70
71     virtual ~IPDF_TextPage() {}
72     static IPDF_TextPage*       CreateTextPage(const CPDF_Page* pPage, CPDFText_ParseOptions ParserOptions);
73     static IPDF_TextPage*       CreateTextPage(const CPDF_Page* pPage, int flags = 0);
74     static IPDF_TextPage*       CreateTextPage(const CPDF_PageObjects* pObjs, int flags = 0);
75     static IPDF_TextPage*       CreateReflowTextPage(IPDF_ReflowedPage* pRefPage);
76
77     virtual void                        NormalizeObjects(FX_BOOL bNormalize) = 0;
78
79     virtual FX_BOOL                     ParseTextPage() = 0;
80
81
82     virtual FX_BOOL                     IsParsered() const = 0;
83 public:
84
85     virtual int CharIndexFromTextIndex(int TextIndex) const = 0;
86
87     virtual int TextIndexFromCharIndex(int CharIndex) const = 0;
88
89
90     virtual int                         CountChars() const = 0;
91
92     virtual     void                    GetCharInfo(int index, FPDF_CHAR_INFO & info) const = 0;
93
94     virtual void                        GetRectArray(int start, int nCount, CFX_RectArray& rectArray) const = 0;
95
96
97
98     virtual int                         GetIndexAtPos(CPDF_Point point, FX_FLOAT xTorelance, FX_FLOAT yTorelance) const = 0;
99
100     virtual int                         GetIndexAtPos(FX_FLOAT x, FX_FLOAT y, FX_FLOAT xTorelance, FX_FLOAT yTorelance) const = 0;
101
102     virtual     int                             GetOrderByDirection(int index, int direction) const = 0;
103
104     virtual CFX_WideString      GetTextByRect(const CFX_FloatRect& rect) const = 0;
105
106     virtual void                        GetRectsArrayByRect(const CFX_FloatRect& rect, CFX_RectArray& resRectArray) const = 0;
107
108
109     virtual int                         CountRects(int start, int nCount) = 0;
110
111     virtual     void                    GetRect(int rectIndex, FX_FLOAT& left, FX_FLOAT& top, FX_FLOAT& right, FX_FLOAT &bottom) const = 0;
112
113     virtual FX_BOOL                     GetBaselineRotate(int rectIndex, int& Rotate) = 0;
114
115     virtual FX_BOOL                     GetBaselineRotate(const CFX_FloatRect& rect, int& Rotate) = 0;
116
117     virtual     int                             CountBoundedSegments(FX_FLOAT left, FX_FLOAT top, FX_FLOAT right, FX_FLOAT bottom, FX_BOOL bContains = FALSE) = 0;
118
119     virtual     void                    GetBoundedSegment(int index, int& start, int& count) const = 0;
120
121
122     virtual int                         GetWordBreak(int index, int direction) const = 0;
123
124     virtual CFX_WideString      GetPageText(int start = 0, int nCount = -1 ) const = 0;
125 };
126 #define FPDFTEXT_MATCHCASE      0x00000001
127 #define FPDFTEXT_MATCHWHOLEWORD 0x00000002
128 #define FPDFTEXT_CONSECUTIVE    0x00000004
129 class IPDF_TextPageFind 
130 {
131 public:
132
133     virtual     ~IPDF_TextPageFind() {}
134
135     static      IPDF_TextPageFind*      CreatePageFind(const IPDF_TextPage* pTextPage);
136 public:
137
138     virtual     FX_BOOL                         FindFirst(const CFX_WideString& findwhat, int flags, int startPos = 0) = 0;
139
140     virtual     FX_BOOL                         FindNext() = 0;
141
142     virtual     FX_BOOL                         FindPrev() = 0;
143
144     virtual void                                GetRectArray(CFX_RectArray& rects) const = 0;
145
146     virtual int                                 GetCurOrder() const = 0;
147
148     virtual int                                 GetMatchedCount() const = 0;
149 };
150 class IPDF_LinkExtract 
151 {
152 public:
153
154     virtual     ~IPDF_LinkExtract() {}
155
156     static      IPDF_LinkExtract*       CreateLinkExtract();
157
158     virtual FX_BOOL                             ExtractLinks(const IPDF_TextPage* pTextPage) = 0;
159 public:
160
161     virtual int                                 CountLinks() const = 0;
162
163     virtual CFX_WideString              GetURL(int index) const = 0;
164
165     virtual     void                            GetBoundedSegment(int index, int& start, int& count) const = 0;
166
167     virtual void                                GetRects(int index, CFX_RectArray& rects) const = 0;
168 };
169
170 #endif  // CORE_INCLUDE_FPDFTEXT_FPDF_TEXT_H_