options.h

Go to the documentation of this file.

// Copyright (C) 2025 Artifex Software, Inc.
//
// This file is part of MuPDF.
//
// MuPDF is free software: you can redistribute it and/or modify it under the
// terms of the GNU Affero General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// MuPDF is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
// details.
//
// You should have received a copy of the GNU Affero General Public License
// along with MuPDF. If not, see <https://www.gnu.org/licenses/agpl-3.0.en.html>
//
// Alternative licensing terms are available from the licensor.
// For commercial licensing, see <https://www.artifex.com/> or contact
// Artifex Software, Inc., 39 Mesa Street, Suite 108A, San Francisco,
// CA 94129, USA, for further information.
 
#ifndef MUPDF_FITZ_OPTIONS_H
#define MUPDF_FITZ_OPTIONS_H
 
#include "mupdf/fitz/context.h"
#include "mupdf/fitz/pool.h"

typedef struct fz_options fz_options;

fz_options *fz_new_options(fz_context *ctx, const char *option_string);

void fz_parse_options(fz_context *ctx, fz_options *options, const char *option_string);

fz_options *fz_keep_options(fz_context *ctx, fz_options *opts);

void fz_drop_options(fz_context *ctx, fz_options *opts);

int fz_lookup_option(fz_context *ctx, fz_options *options, const char *key, const char **val);

int fz_lookup_option_yes(fz_context *ctx, fz_options *options, const char *key);

int fz_lookup_option_boolean(fz_context *ctx, fz_options *options, const char *key, int *x);

int fz_lookup_option_float(fz_context *ctx, fz_options *options, const char *key, float *x);
int fz_lookup_option_integer(fz_context *ctx, fz_options *options, const char *key, int *x);
int fz_lookup_option_unsigned(fz_context *ctx, fz_options *options, const char *key, unsigned int *x);
 
typedef struct
{
    const char *key;
    int val;
} fz_option_enums;
 
/*
    Check to see if an option is present. Look for it in the given fz_option_enums
    array, which is expected to end with an entry with a NULL key.
 
    If the option is not found, return 0.
 
    If the option is found, and a matching entry in the list exists, then *x will
    be set to the 'val' from that entry, the invalid flag is cleared, and we will return 1.
 
    If the option is found, and no matching entry in the list exists, then *x will
    be set to the 'val' from the terminating NULL entry, the invalid flag will be set,
    and we will return -1.
*/
int fz_lookup_option_enum(fz_context *ctx, fz_options *options, const char *key, int *x,
    const fz_option_enums *enum_list);

void fz_validate_options(fz_context *ctx, fz_options *options, const char *prefix);

void fz_warn_on_unused_options(fz_context *ctx, fz_options *options, const char *prefix);

void fz_throw_on_unused_options(fz_context *ctx, fz_options *options, const char *prefix);
 

int fz_count_options(fz_context *ctx, fz_options *options);

const char *fz_get_option_by_index(fz_context *ctx, fz_options *options, int i, const char **val);

void fz_access_option_by_index(fz_context *ctx, fz_options *options, int i);

 
typedef struct fz_option
{
    int flags;
    char *key;
    char *val;
    struct fz_option *next;
} fz_option;
 
struct fz_options {
    int refs;
    fz_pool *pool;
    fz_option *head;
};
 
#endif