Python2/PyMuPDF: mupdf-source/scripts/wrap/__main_

author	Franz Glasner <fzglas.hg@dom66.de>
date	Mon, 15 Sep 2025 11:43:07 +0200
parents
children	b5f06508363a aa33339d6b8a

rev	line source
2 b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1 #!/usr/bin/env python3
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	3 r'''
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	4 Support for generating C++ and python wrappers for the mupdf API.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	5
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	6 Overview:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	7
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	8 We generate C++, Python and C# wrappers.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	9
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	10
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	11 C++ wrapping:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	12
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	13 Namespaces:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	14
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	15 All generated functions and classes are in the 'mupdf' namespace.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	16
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	17 Wrapper classes:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	18
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	19 For each MuPDF C struct, we provide a wrapper class with a CamelCase
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	20 version of the struct name, e.g. the wrapper for fz_display_list is
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	21 mupdf::FzDisplayList.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	22
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	23 These wrapper classes generally have a member `m_internal` that is a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	24 pointer to an instance of the underlying struct.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	25
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	26 Member functions:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	27
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	28 Member functions are provided which wrap all relevant MuPDF C
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	29 functions (those with first arg being a pointer to an instance of
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	30 the C struct). These methods have the same name as the wrapped
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	31 function.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	32
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	33 They generally take args that are references to wrapper classes
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	34 instead of pointers to MuPDF C structs, and similarly return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	35 wrapper classes by value instead of returning a pointer to a MuPDF
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	36 C struct.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	37
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	38 Reference counting:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	39
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	40 Wrapper classes automatically take care of reference counting, so
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	41 user code can freely use instances of wrapper classes as required,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	42 for example making copies and allowing instances to go out of
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	43 scope.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	44
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	45 Lifetime-related functions - constructors, copy constructors,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	46 operator= and destructors - make internal calls to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	47 `fz_keep_<structname>()` and `fz_drop_<structname>()` as required.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	48
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	49 Raw constructors that take a pointer to an underlying MuPDF struct
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	50 do not call `fz_keep_*()` - it is expected that any supplied MuPDF
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	51 struct is already owned. Most of the time user code will not need
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	52 to use raw constructors directly.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	53
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	54 Debugging reference counting:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	55
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	56 If environmental variable MUPDF_check_refs is "1", we do
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	57 runtime checks of the generated code's handling of structs that
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	58 have a reference count (i.e. they have a `int refs;` member).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	59
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	60 If the number of wrapper class instances for a particular MuPDF
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	61 struct instance is more than the `.ref` value for that struct
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	62 instance, we generate a diagnostic and call `abort()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	63
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	64 We also output reference-counting diagnostics each time a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	65 wrapper class constructor, member function or destructor is
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	66 called.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	67
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	68 POD wrappers:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	69
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	70 For simple POD structs such as `fz_rect` which are not reference
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	71 counted, the wrapper class's `m_internal` can be an instance of
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	72 the underlying struct instead of a pointer. Some wrappers for POD
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	73 structs take this one step further and embed the struct members
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	74 directly in the wrapper class.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	75
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	76 Wrapper functions:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	77
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	78 Class-aware wrappers:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	79
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	80 We provide a class-aware wrapper for each MuPDF C function; these
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	81 have the same name as the MuPDF C function and are identical to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	82 the corresponding class member function except that they take an
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	83 explicit first arg instead of the implicit C++ `this`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	84
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	85 Low-level wrappers:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	86
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	87 We provide a low-level wrapper for each C MuPDF function; these
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	88 have a `ll_` prefix, do not take a 'fz_context* ctx' arg, and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	89 convert any fz_try..fz_catch exceptions into C++ exceptions.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	90
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	91 Most calling code should use class-aware wrapper functions or
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	92 wrapper class methods in preference to these low-level wrapper
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	93 functions.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	94
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	95 Text representation of POD data:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	96
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	97 For selected POD MuPDF structs, we provide functions that give a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	98 labelled text representation of the data, for example a `fz_rect` will
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	99 be represented like:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	100
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	101 (x0=90.51 y0=160.65 x1=501.39 y1=215.6)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	102
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	103 Text representation of a POD wrapper class:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	104
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	105 * An `operator<< (std::ostream&, <wrapperclass>&)` overload for the wrapper class.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	106 * A member function `std::string to_string();` in the wrapper class.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	107
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	108 Text representation of a MuPDF POD C struct:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	109
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	110 * Function `std::string to_string( const <structname>&);`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	111 * Function `std::string to_string_<structname>( const <structname>&);`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	112
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	113 Examples:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	114
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	115 MuPDF C API:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	116
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	117 fz_device fz_begin_page(fz_context ctx, fz_document_writer *wri, fz_rect mediabox);
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	118
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	119 MuPDF C++ API:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	120
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	121 namespace mupdf
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	122 {
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	123 struct FzDevice
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	124 {
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	125 ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	126 fz_device* m_internal;
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	127 };
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	128
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	129 struct FzDocumentWriter
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	130 {
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	131 ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	132 FzDevice fz_begin_page(FzRect& mediabox);
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	133 ...
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	134 fz_document_writer* m_internal;
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	135 };
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	136
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	137 FzDevice fz_begin_page(const FzDocumentWriter& wri, FzRect& mediabox);
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	138
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	139 fz_device ll_fz_begin_page(fz_document_writer wri, fz_rect mediabox);
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	140 }
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	141
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	142 Environmental variables control runtime diagnostics in debug builds of
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	143 generated code:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	144
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	145 MUPDF_trace
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	146 If "1", generated code outputs a diagnostic each time it calls
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	147 a MuPDF function, showing the args.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	148
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	149 MUPDF_trace_director
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	150 If "1", generated code outputs a diagnostic when doing special
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	151 handling of MuPDF structs containing function pointers.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	152
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	153 MUPDF_trace_exceptions
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	154 If "1", generated code outputs diagnostics when we catch a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	155 MuPDF setjmp/longjmp exception and convert it into a C++
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	156 exception.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	157
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	158 MUPDF_check_refs
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	159 If "1", generated code checks MuPDF struct reference counts at
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	160 runtime. See below for details.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	161
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	162 Details:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	163
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	164 We use clang-python to parse the MuPDF header files, and generate C++
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	165 headers and source code that gives wrappers for all MuPDF functions.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	166
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	167 We also generate C++ classes that wrap all MuPDF structs, adding in
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	168 various constructors and methods that wrap auto-detected MuPDF C
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	169 functions, plus explicitly-specified methods that wrap/use MuPDF C
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	170 functions.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	171
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	172 More specifically, for each wrapper class:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	173
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	174 Copy constructors/operator=:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	175
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	176 If `fz_keep_<name>()` and `fz_drop_<name>()` exist, we generate
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	177 copy constructor and `operator=()` that use these functions.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	178
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	179 Constructors:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	180
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	181 We look for all MuPDF functions called `fz_new_*()` or
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	182 `pdf_new_*()` that return a pointer to the wrapped class, and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	183 wrap these into constructors. If any of these constructors have
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	184 duplicate prototypes, we cannot provide them as constructors so
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	185 instead we provide them as static methods. This is not possible
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	186 if the class is not copyable, in which case we include the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	187 constructor code but commented-out and with an explanation.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	188
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	189 Methods:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	190
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	191 We look for all MuPDF functions that take the wrapped struct as
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	192 a first arg (ignoring any `fz_context*` arg), and wrap these
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	193 into auto-generated class methods. If there are duplicate
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	194 prototypes, we comment-out all but the first.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	195
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	196 Auto-generated methods are omitted if a custom method is
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	197 defined with the same name.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	198
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	199 Other:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	200
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	201 There are various subleties with wrapper classes for MuPDF
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	202 structs that are not copyable etc.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	203
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	204 Internal `fz_context*`'s:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	205
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	206 `mupdf::*` functions and methods generally have the same args
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	207 as the MuPDF functions that they wrap except that they don't
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	208 take any `fz_context*` parameter. When required, per-thread
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	209 `fz_context`'s are generated automatically at runtime, using
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	210 `platform/c++/implementation/internal.cpp:internal_context_get()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	211
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	212 Extra items:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	213
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	214 `mupdf::metadata_keys`: This is a global const vector of
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	215 strings contains the keys that are suitable for passing to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	216 `fz_lookup_metadata()` and its wrappers.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	217
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	218 Output parameters:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	219
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	220 We provide two different ways of wrapping functions with
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	221 out-params.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	222
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	223 Using SWIG OUTPUT markers:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	224
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	225 First, in generated C++ prototypes, we use `OUTPUT` as
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	226 the name of out-params, which tells SWIG to treat them as
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	227 out-params. This works for basic out-params such as `int*`, so
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	228 SWIG will generate Python code that returns a tuple and C# code
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	229 that takes args marked with the C# keyword `out`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	230
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	231 Unfortunately SWIG doesn't appear to handle out-params that
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	232 are zero terminated strings (`char**`) and cannot generically
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	233 handle binary data out-params (often indicated with `unsigned
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	234 char**`). Also, SWIG-generated C# out-params are a little
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	235 inconvenient compared to returning a C# tuple (requires C# 7 or
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	236 later).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	237
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	238 So we provide an additional mechanism in the generated C++.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	239
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	240 Out-params in a struct:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	241
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	242 For each function with out-params, we provide a class
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	243 containing just the out-params and a function taking just the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	244 non-out-param args, plus a pointer to the class. This function
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	245 fills in the members of this class instead of returning
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	246 individual out-params. We then generate extra Python or C# code
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	247 that uses these special functions to get the out-params in a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	248 class instance and return them as a tuple in both Python and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	249 C#.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	250
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	251 Binary out-param data:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	252
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	253 Some MuPDF functions return binary data, typically with an
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	254 `unsigned char**` out-param. It is not possible to generically
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	255 handle these in Python or C# because the size of the returned
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	256 buffer is specified elsewhere (for example in a different
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	257 out-param or in the return value). So we generate custom Python
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	258 and C# code to give a convenient interface, e.g. copying the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	259 returned data into a Python `bytes` object or a C# byte array.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	260
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	261
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	262 Python wrapping:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	263
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	264 We generate a Python module called `mupdf` which directly wraps the C++ API,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	265 using identical names for functions, classes and methods.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	266
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	267 Out-parameters:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	268
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	269 Functions and methods that have out-parameters are modified to return
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	270 the out-parameters directly, usually as a tuple.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	271
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	272 Examples:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	273
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	274 `fz_read_best()`:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	275
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	276 MuPDF C function:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	277
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	278 `fz_buffer fz_read_best(fz_context ctx, fz_stream stm, size_t initial, int truncated);`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	279
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	280 Class-aware C++ wrapper:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	281
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	282 `FzBuffer read_best(FzStream& stm, size_t initial, int *truncated);`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	283
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	284 Class-aware python wrapper:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	285
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	286 `def read_best(stm, initial)`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	287
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	288 and returns: `(buffer, truncated)`, where `buffer` is a SWIG
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	289 proxy for a `FzBuffer` instance and `truncated` is an integer.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	290
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	291 `pdf_parse_ind_obj()`:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	292
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	293 MuPDF C function:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	294
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	295 `pdf_obj pdf_parse_ind_obj(fz_context ctx, pdf_document doc, fz_stream f, int num, int gen, int64_t stm_ofs, int try_repair);`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	296
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	297 Class-aware C++ wrapper:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	298
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	299 `PdfObj pdf_parse_ind_obj(PdfDocument& doc, const FzStream& f, int num, int gen, int64_t stm_ofs, int try_repair);`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	300
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	301 Class-aware Python wrapper:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	302
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	303 `def pdf_parse_ind_obj(doc, f)`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	304
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	305 and returns: (ret, num, gen, stm_ofs, try_repair)
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	306
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	307 Special handing if `fz_buffer` data:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	308
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	309 Generic data access:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	310
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	311 `mupdf.python_buffer_data(b: bytes)`:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	312 Returns SWIG proxy for an `unsigned char*` that points to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	313 `<b>`'s data.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	314
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	315 `mupdf.raw_to_python_bytes(data, size):`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	316 Returns Python `bytes` instance containing copy of data
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	317 specified by `data` (a SWIG proxy for a `const unsigned char*
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	318 c`) and `size` (the length of the data).
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	319
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	320 Wrappers for `fz_buffer_extract()`:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	321
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	322 These return a Python `bytes` instance containing a copy of the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	323 buffer's data and the buffer is left empty. This is equivalent to
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	324 the underlying fz_buffer_extract() function, but it involves an
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	325 internal copy of the data.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	326
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	327 New function `fz_buffer_extract_copy` and new method
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	328 `FzBuffer.buffer_extract_copy()` are like `fz_buffer_extract()`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	329 except that they don't clear the buffer. They have no direct
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	330 analogy in the C API.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	331
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	332 Wrappers for `fz_buffer_storage()`:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	333
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	334 These return `(size, data)` where `data` is a low-level
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	335 SWIG representation of the buffer's storage. One can call
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	336 `mupdf.raw_to_python_bytes(data, size)` to get a Python `bytes`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	337 object containing a copy of this data.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	338
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	339 Wrappers for `fz_new_buffer_from_copied_data()`:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	340
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	341 These take a Python `bytes` instance.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	342
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	343 One can create an MuPDF buffer that contains a copy of a Python
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	344 `bytes` by using the special `mupdf.python_buffer_data()`
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	345 function. This returns a SWIG proxy for an `unsigned char*` that
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	346 points to the `bytes` instance's data:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	347
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	348 ```
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	349 bs = b'qwerty'
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	350 buffer_ = mupdf.new_buffer_from_copied_data(mupdf.python_buffer_data(bs), len(bs))
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	351 ```
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	352
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	353 Functions taking a `va_list` arg:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	354
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	355 We do not provide Python wrappers for functions such as `fz_vsnprintf()`.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	356
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	357 Details:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	358
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	359 The Python module is generated using SWIG.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	360
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	361 Out-parameters:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	362
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	363 Out-parameters are not implemented using SWIG typemaps because it's
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	364 very difficult to make things work that way. Instead we internally
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	365 create a struct containing the out-params together with C and
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	366 Python wrapper functions that use the struct to pass the out-params
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	367 back from C into Python.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	368
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	369 The Python function ends up returning the out parameters in the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	370 same order as they occur in the original function's args, prefixed
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	371 by the original function's return value if it is not void.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	372
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	373 If a function returns void and has exactly one out-param, the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	374 Python wrapper will return the out-param directly, not as part of a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	375 tuple.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	376
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	377
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	378 Tools required to build:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	379
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	380 Clang:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	381
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	382 Clang versions:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	383
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	384 We work with clang-6 or clang-7, but clang-6 appears to not be able
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	385 to cope with function args that are themselves function pointers,
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	386 so wrappers for MuPDF functions are omitted from the generated C++
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	387 code.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	388
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	389 Unix:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	390
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	391 It seems that clang-python packages such as Debian's python-clang
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	392 and OpenBSD's py3-llvm require us to explicitly specify the
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	393 location of libclang, so we search in various locations.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	394
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	395 Alternatively on Linux one can (perhaps in a venv) do:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	396
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	397 pip install libclang
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	398
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	399 This makes clang available directly as a Python module.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	400
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	401 On Windows, one must install clang-python with:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	402
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	403 pip install libclang
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	404
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	405 setuptools:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	406 Used internally.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	407
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	408 SWIG for Python/C# bindings:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	409
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	410 We work with swig-3 and swig-4. If swig-4 is used, we propagate
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	411 doxygen-style comments for structures and functions into the generated
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	412 C++ code.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	413
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	414 Mono for C# bindings on Unix.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	415
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	416
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	417 Building Python bindings:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	418
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	419 Build and install the MuPDF Python bindings as module `mupdf` in a Python
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	420 virtual environment, using MuPDF's `setup.py` script:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	421
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	422 Linux:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	423 > python3 -m venv pylocal
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	424 > . pylocal/bin/activate
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	425 (pylocal) > pip install pyqt5 libclang
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	426 (pylocal) > cd .../mupdf
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	427 (pylocal) > python setup.py install
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	428
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	429 Windows:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	430 > py -m venv pylocal
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	431 > pylocal\Scripts\activate
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	432 (pylocal) > pip install libclang pyqt5
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	433 (pylocal) > cd ...\mupdf
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	434 (pylocal) > python setup.py install
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	435
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	436 OpenBSD:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	437 [It seems that pip can't install pyqt5 or libclang so instead we
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	438 install system packages and use --system-site-packages.]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	439
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	440 > sudo pkg_add py3-llvm py3-qt5
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	441 > python3 -m venv --system-site-packages pylocal
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	442 > . pylocal/bin/activate
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	443 (pylocal) > cd .../mupdf
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	444 (pylocal) > python setup.py install
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	445
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	446 Use the mupdf module:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	447 (pylocal) > python
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	448 >>> import mupdf
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	449 >>>
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	450
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	451 Build MuPDF Python bindings without a Python virtual environment, using
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	452 scripts/mupdfwrap.py:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	453
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	454 [Have not yet found a way to use clang from python on Windows without a
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	455 virtual environment, so this is Unix-only.]
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	456
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	457 > cd .../mupdf
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	458
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	459 Install required packages:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	460 Debian:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	461 > sudo apt install clang python3-clang python3-dev swig
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	462
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	463 OpenBSD:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	464 > pkg_add py3-llvm py3-qt5
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	465
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	466 Build and test:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	467 > ./scripts/mupdfwrap.py -d build/shared-release -b all --test-python
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	468
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	469 Use the mupdf module by setting PYTHONPATH:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	470 > PYTHONPATH=build/shared-release python3
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	471 >>> import mupdf
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	472 >>>
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	473
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	474
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	475 Building C# bindings:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	476
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	477 Build MuPDF C# bindings using scripts/mupdfwrap.py:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	478
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	479 > cd .../mupdf
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	480
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	481 Install required packages:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	482 Debian:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	483 > sudo apt install clang python3-clang python3-dev mono-devel
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	484
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	485 OpenBSD:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	486 > sudo pkg_add py3-llvm py3-qt5 mono
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	487
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	488 Build and test:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	489 > ./scripts/mupdfwrap.py -d build/shared-release -b --csharp all --test-csharp
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	490
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	491
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	492 Windows builds:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	493
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	494 Required predefined macros:
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	495
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	496 Code that will use the MuPDF DLL must be built with FZ_DLL_CLIENT
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	497 predefined.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	498
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	499 The MuPDF DLL itself is built with FZ_DLL predefined.
b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	500

2

b50eed0cc0ef ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4.