unpdf 0.4.5

High-performance PDF content extraction to Markdown, text, and JSON
Documentation
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
using System;
using System.Runtime.InteropServices;
using System.Text;
using System.Text.Json;

namespace Unpdf;

/// <summary>
/// Options for markdown rendering.
/// </summary>
public class MarkdownOptions
{
    /// <summary>
    /// Include YAML frontmatter with document metadata.
    /// </summary>
    public bool IncludeFrontmatter { get; set; } = false;

    /// <summary>
    /// Escape special markdown characters.
    /// </summary>
    public bool EscapeSpecialChars { get; set; } = false;

    /// <summary>
    /// Add extra spacing between paragraphs.
    /// </summary>
    public bool ParagraphSpacing { get; set; } = false;

    internal int ToFlags()
    {
        int flags = 0;
        if (IncludeFrontmatter) flags |= NativeMethods.UNPDF_FLAG_FRONTMATTER;
        if (EscapeSpecialChars) flags |= NativeMethods.UNPDF_FLAG_ESCAPE_SPECIAL;
        if (ParagraphSpacing) flags |= NativeMethods.UNPDF_FLAG_PARAGRAPH_SPACING;
        return flags;
    }
}

/// <summary>
/// Represents a parsed PDF document.
/// </summary>
/// <remarks>
/// This class provides methods to extract content from PDF documents
/// in various formats (Markdown, plain text, JSON).
/// </remarks>
public class UnpdfDocument : IDisposable
{
    private IntPtr _handle;
    private bool _disposed;

    private UnpdfDocument(IntPtr handle)
    {
        _handle = handle;
    }

    /// <summary>
    /// Get the unpdf library version.
    /// </summary>
    public static string Version
    {
        get
        {
            var ptr = NativeMethods.unpdf_version();
            return Marshal.PtrToStringAnsi(ptr) ?? "unknown";
        }
    }

    /// <summary>
    /// Parse a document from a file path.
    /// </summary>
    /// <param name="path">Path to the PDF file</param>
    /// <returns>Parsed document</returns>
    /// <exception cref="UnpdfException">If parsing fails</exception>
    /// <exception cref="FileNotFoundException">If file doesn't exist</exception>
    public static UnpdfDocument ParseFile(string path)
    {
        if (!System.IO.File.Exists(path))
            throw new System.IO.FileNotFoundException($"File not found: {path}", path);

        var handle = NativeMethods.unpdf_parse_file(path);
        if (handle == IntPtr.Zero)
            throw new UnpdfException($"Failed to parse {path}: {GetLastError()}");

        return new UnpdfDocument(handle);
    }

    /// <summary>
    /// Parse a document from a byte array.
    /// </summary>
    /// <param name="data">Document content as bytes</param>
    /// <returns>Parsed document</returns>
    /// <exception cref="UnpdfException">If parsing fails</exception>
    public static UnpdfDocument ParseBytes(byte[] data)
    {
        var dataPtr = Marshal.AllocHGlobal(data.Length);
        try
        {
            Marshal.Copy(data, 0, dataPtr, data.Length);
            var handle = NativeMethods.unpdf_parse_bytes(dataPtr, (UIntPtr)data.Length);
            if (handle == IntPtr.Zero)
                throw new UnpdfException($"Failed to parse bytes: {GetLastError()}");

            return new UnpdfDocument(handle);
        }
        finally
        {
            Marshal.FreeHGlobal(dataPtr);
        }
    }

    /// <summary>
    /// Convert the document to Markdown.
    /// </summary>
    /// <param name="options">Optional rendering options</param>
    /// <returns>Markdown string</returns>
    public string ToMarkdown(MarkdownOptions? options = null)
    {
        ThrowIfDisposed();
        int flags = options?.ToFlags() ?? 0;
        var ptr = NativeMethods.unpdf_to_markdown(_handle, flags);
        if (ptr == IntPtr.Zero)
            throw new UnpdfException($"Failed to convert to markdown: {GetLastError()}");

        try
        {
            return PtrToStringUtf8(ptr);
        }
        finally
        {
            NativeMethods.unpdf_free_string(ptr);
        }
    }

    /// <summary>
    /// Convert the document to plain text.
    /// </summary>
    /// <returns>Plain text string</returns>
    public string ToText()
    {
        ThrowIfDisposed();
        var ptr = NativeMethods.unpdf_to_text(_handle);
        if (ptr == IntPtr.Zero)
            throw new UnpdfException($"Failed to convert to text: {GetLastError()}");

        try
        {
            return PtrToStringUtf8(ptr);
        }
        finally
        {
            NativeMethods.unpdf_free_string(ptr);
        }
    }

    /// <summary>
    /// Convert the document to JSON.
    /// </summary>
    /// <param name="compact">Use compact JSON format</param>
    /// <returns>JSON string</returns>
    public string ToJson(bool compact = false)
    {
        ThrowIfDisposed();
        int format = compact ? NativeMethods.UNPDF_JSON_COMPACT : NativeMethods.UNPDF_JSON_PRETTY;
        var ptr = NativeMethods.unpdf_to_json(_handle, format);
        if (ptr == IntPtr.Zero)
            throw new UnpdfException($"Failed to convert to JSON: {GetLastError()}");

        try
        {
            return PtrToStringUtf8(ptr);
        }
        finally
        {
            NativeMethods.unpdf_free_string(ptr);
        }
    }

    /// <summary>
    /// Get plain text content (faster than ToText for simple extraction).
    /// </summary>
    /// <returns>Plain text string</returns>
    public string PlainText()
    {
        ThrowIfDisposed();
        var ptr = NativeMethods.unpdf_plain_text(_handle);
        if (ptr == IntPtr.Zero)
            throw new UnpdfException($"Failed to get plain text: {GetLastError()}");

        try
        {
            return PtrToStringUtf8(ptr);
        }
        finally
        {
            NativeMethods.unpdf_free_string(ptr);
        }
    }

    /// <summary>
    /// Get the number of sections (pages) in the document.
    /// </summary>
    public int SectionCount
    {
        get
        {
            ThrowIfDisposed();
            var count = NativeMethods.unpdf_section_count(_handle);
            if (count < 0)
                throw new UnpdfException($"Failed to get section count: {GetLastError()}");
            return count;
        }
    }

    /// <summary>
    /// Get the number of resources in the document.
    /// </summary>
    public int ResourceCount
    {
        get
        {
            ThrowIfDisposed();
            var count = NativeMethods.unpdf_resource_count(_handle);
            if (count < 0)
                throw new UnpdfException($"Failed to get resource count: {GetLastError()}");
            return count;
        }
    }

    /// <summary>
    /// Get the document title, if set.
    /// </summary>
    public string? Title
    {
        get
        {
            ThrowIfDisposed();
            var ptr = NativeMethods.unpdf_get_title(_handle);
            if (ptr == IntPtr.Zero)
                return null;

            try
            {
                return PtrToStringUtf8(ptr);
            }
            finally
            {
                NativeMethods.unpdf_free_string(ptr);
            }
        }
    }

    /// <summary>
    /// Get the document author, if set.
    /// </summary>
    public string? Author
    {
        get
        {
            ThrowIfDisposed();
            var ptr = NativeMethods.unpdf_get_author(_handle);
            if (ptr == IntPtr.Zero)
                return null;

            try
            {
                return PtrToStringUtf8(ptr);
            }
            finally
            {
                NativeMethods.unpdf_free_string(ptr);
            }
        }
    }

    /// <summary>
    /// Convert a single page to Markdown.
    /// </summary>
    /// <param name="pageNumber">Page number (1-indexed)</param>
    /// <param name="options">Optional rendering options</param>
    /// <returns>Markdown string for the specified page</returns>
    /// <exception cref="UnpdfException">If the page number is out of range or rendering fails</exception>
    public string PageToMarkdown(int pageNumber, MarkdownOptions? options = null)
    {
        ThrowIfDisposed();
        int flags = options?.ToFlags() ?? 0;
        var ptr = NativeMethods.unpdf_page_to_markdown(_handle, pageNumber, flags);
        if (ptr == IntPtr.Zero)
            throw new UnpdfException($"Failed to convert page {pageNumber} to markdown: {GetLastError()}");

        try
        {
            return PtrToStringUtf8(ptr);
        }
        finally
        {
            NativeMethods.unpdf_free_string(ptr);
        }
    }

    /// <summary>
    /// Get the plain text of a single page.
    /// </summary>
    /// <param name="pageNumber">Page number (1-indexed)</param>
    /// <returns>Plain text string for the specified page</returns>
    /// <exception cref="UnpdfException">If the page number is out of range</exception>
    public string PageToText(int pageNumber)
    {
        ThrowIfDisposed();
        var ptr = NativeMethods.unpdf_page_to_text(_handle, pageNumber);
        if (ptr == IntPtr.Zero)
            throw new UnpdfException($"Failed to get text for page {pageNumber}: {GetLastError()}");

        try
        {
            return PtrToStringUtf8(ptr);
        }
        finally
        {
            NativeMethods.unpdf_free_string(ptr);
        }
    }

    /// <summary>
    /// Get list of resource IDs in the document.
    /// </summary>
    /// <returns>Array of resource ID strings</returns>
    public string[] GetResourceIds()
    {
        ThrowIfDisposed();
        var ptr = NativeMethods.unpdf_get_resource_ids(_handle);
        if (ptr == IntPtr.Zero)
            return Array.Empty<string>();

        try
        {
            var json = PtrToStringUtf8(ptr);
            return JsonSerializer.Deserialize<string[]>(json) ?? Array.Empty<string>();
        }
        finally
        {
            NativeMethods.unpdf_free_string(ptr);
        }
    }

    /// <summary>
    /// Get metadata for a resource.
    /// </summary>
    /// <param name="resourceId">The resource ID</param>
    /// <returns>Resource metadata as JSON, or null if not found</returns>
    public JsonDocument? GetResourceInfo(string resourceId)
    {
        ThrowIfDisposed();
        var ptr = NativeMethods.unpdf_get_resource_info(_handle, resourceId);
        if (ptr == IntPtr.Zero)
            return null;

        try
        {
            var json = PtrToStringUtf8(ptr);
            return JsonDocument.Parse(json);
        }
        finally
        {
            NativeMethods.unpdf_free_string(ptr);
        }
    }

    /// <summary>
    /// Get binary data for a resource.
    /// </summary>
    /// <param name="resourceId">The resource ID</param>
    /// <returns>Resource data as bytes, or null if not found</returns>
    public byte[]? GetResourceData(string resourceId)
    {
        ThrowIfDisposed();
        var ptr = NativeMethods.unpdf_get_resource_data(_handle, resourceId, out var length);
        if (ptr == IntPtr.Zero)
            return null;

        try
        {
            var data = new byte[(int)length];
            Marshal.Copy(ptr, data, 0, data.Length);
            return data;
        }
        finally
        {
            NativeMethods.unpdf_free_bytes(ptr, length);
        }
    }

    private static string GetLastError()
    {
        var ptr = NativeMethods.unpdf_last_error();
        if (ptr == IntPtr.Zero)
            return "Unknown error";
        return Marshal.PtrToStringAnsi(ptr) ?? "Unknown error";
    }

    private static string PtrToStringUtf8(IntPtr ptr)
    {
        if (ptr == IntPtr.Zero)
            return string.Empty;

        // Find null terminator
        int len = 0;
        while (Marshal.ReadByte(ptr, len) != 0)
            len++;

        if (len == 0)
            return string.Empty;

        byte[] buffer = new byte[len];
        Marshal.Copy(ptr, buffer, 0, len);
        return Encoding.UTF8.GetString(buffer);
    }

    private void ThrowIfDisposed()
    {
        if (_disposed)
            throw new ObjectDisposedException(nameof(UnpdfDocument));
    }

    /// <summary>
    /// Releases all resources used by this <see cref="UnpdfDocument"/>.
    /// </summary>
    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    /// <summary>
    /// Releases the unmanaged resources used by this <see cref="UnpdfDocument"/>
    /// and optionally releases the managed resources.
    /// </summary>
    /// <param name="disposing">
    /// <see langword="true"/> to release both managed and unmanaged resources;
    /// <see langword="false"/> to release only unmanaged resources.
    /// </param>
    protected virtual void Dispose(bool disposing)
    {
        if (!_disposed)
        {
            if (_handle != IntPtr.Zero)
            {
                NativeMethods.unpdf_free_document(_handle);
                _handle = IntPtr.Zero;
            }
            _disposed = true;
        }
    }

    /// <summary>
    /// Finalizer that ensures the native document handle is freed.
    /// </summary>
    ~UnpdfDocument()
    {
        Dispose(false);
    }
}