outline.h

Go to the documentation of this file.

// Copyright (C) 2004-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_OUTLINE_H
#define MUPDF_FITZ_OUTLINE_H
 
#include "mupdf/fitz/system.h"
#include "mupdf/fitz/types.h"
#include "mupdf/fitz/context.h"
#include "mupdf/fitz/link.h"
#include "mupdf/fitz/output.h"
 
/* Outline */
 
typedef struct {
    char *title;
    char *uri;
    int is_open;
    int flags;
    float r;
    float g;
    float b;
} fz_outline_item;
 
enum
{
    FZ_OUTLINE_FLAG_BOLD = 1,
    FZ_OUTLINE_FLAG_ITALIC = 2,
};
 
enum
{
    FZ_OUTLINE_ITERATOR_DID_NOT_MOVE = -1,
    FZ_OUTLINE_ITERATOR_AT_ITEM = 0,
    FZ_OUTLINE_ITERATOR_AT_EMPTY = 1,
};
 
typedef struct fz_outline_iterator fz_outline_iterator;

fz_outline_item *fz_outline_iterator_item(fz_context *ctx, fz_outline_iterator *iter);

int fz_outline_iterator_next(fz_context *ctx, fz_outline_iterator *iter);
int fz_outline_iterator_prev(fz_context *ctx, fz_outline_iterator *iter);
int fz_outline_iterator_up(fz_context *ctx, fz_outline_iterator *iter);
int fz_outline_iterator_down(fz_context *ctx, fz_outline_iterator *iter);

int fz_outline_iterator_insert(fz_context *ctx, fz_outline_iterator *iter, fz_outline_item *item);

int fz_outline_iterator_delete(fz_context *ctx, fz_outline_iterator *iter);

void fz_outline_iterator_update(fz_context *ctx, fz_outline_iterator *iter, fz_outline_item *item);

void fz_drop_outline_iterator(fz_context *ctx, fz_outline_iterator *iter);
 


typedef struct fz_outline
{
    int refs;
    char *title;
    char *uri;
    fz_location page;
    float x, y;
    struct fz_outline *next;
    struct fz_outline *down;
    unsigned int is_open : 1;
    unsigned int flags : 7;
    unsigned int r : 8;
    unsigned int g : 8;
    unsigned int b : 8;
} fz_outline;

fz_outline *fz_new_outline(fz_context *ctx);

fz_outline *fz_keep_outline(fz_context *ctx, fz_outline *outline);

void fz_drop_outline(fz_context *ctx, fz_outline *outline);

fz_outline *
fz_load_outline_from_iterator(fz_context *ctx, fz_outline_iterator *iter);
 


typedef fz_outline_item *(fz_outline_iterator_item_fn)(fz_context *ctx, fz_outline_iterator *iter);

typedef int (fz_outline_iterator_next_fn)(fz_context *ctx, fz_outline_iterator *iter);
typedef int (fz_outline_iterator_prev_fn)(fz_context *ctx, fz_outline_iterator *iter);
typedef int (fz_outline_iterator_up_fn)(fz_context *ctx, fz_outline_iterator *iter);
typedef int (fz_outline_iterator_down_fn)(fz_context *ctx, fz_outline_iterator *iter);

typedef int (fz_outline_iterator_insert_fn)(fz_context *ctx, fz_outline_iterator *iter, fz_outline_item *item);

typedef int (fz_outline_iterator_delete_fn)(fz_context *ctx, fz_outline_iterator *iter);

typedef void (fz_outline_iterator_update_fn)(fz_context *ctx, fz_outline_iterator *iter, fz_outline_item *item);

typedef void (fz_outline_iterator_drop_fn)(fz_context *ctx, fz_outline_iterator *iter);
 
#define fz_new_derived_outline_iter(CTX, TYPE, DOC)\
    ((TYPE *)Memento_label(fz_new_outline_iterator_of_size(ctx,sizeof(TYPE),DOC),#TYPE))
 
fz_outline_iterator *fz_new_outline_iterator_of_size(fz_context *ctx, size_t size, fz_document *doc);
 
fz_outline_iterator *fz_outline_iterator_from_outline(fz_context *ctx, fz_outline *outline);
 
struct fz_outline_iterator {
    /* Functions */
    fz_outline_iterator_drop_fn *drop;
    fz_outline_iterator_item_fn *item;
    fz_outline_iterator_next_fn *next;
    fz_outline_iterator_prev_fn *prev;
    fz_outline_iterator_up_fn *up;
    fz_outline_iterator_down_fn *down;
    fz_outline_iterator_insert_fn *insert;
    fz_outline_iterator_update_fn *update;
    fz_outline_iterator_delete_fn *del;
    /* Common state */
    fz_document *doc;
};
 
#endif