src/hb-subset-serialize.h

/*
 * Copyright © 2022  Google, Inc.
 *
 *  This is part of HarfBuzz, a text shaping library.
 *
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the
 * above copyright notice and the following two paragraphs appear in
 * all copies of this software.
 *
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 *
 */

#ifndef HB_SUBSET_SERIALIZE_H
#define HB_SUBSET_SERIALIZE_H

#if !defined(HB_SUBSET_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
// Disabled to not break pre-existing users.
//#error "Include <hb-subset.h> instead."
#endif

#include "hb.h"

HB_BEGIN_DECLS

/**
 * hb_subset_serialize_link_t:
 * @width: offsetSize in bytes
 * @position: position of the offset field in bytes from
 *            beginning of subtable
 * @objidx: index of subtable
 *
 * Represents a link between two objects in the object graph
 * to be serialized.
 *
 * Since: 10.2.0
 */
typedef struct hb_subset_serialize_link_t {
  unsigned int width;
  unsigned int position;
  unsigned int objidx;
} hb_subset_serialize_link_t;

/**
 * hb_subset_serialize_object_t:
 * @head: start of object data
 * @tail: end of object data
 * @num_real_links: number of offset field in the object
 * @real_links: array of offset info
 * @num_virtual_links: number of objects that must be packed
 *                     after current object in the final
 *                     serialized order
 * @virtual_links: array of virtual link info
 *
 * Represents an object in the object graph to be serialized.
 *
 * Since: 10.2.0
 */
typedef struct hb_subset_serialize_object_t {
  char *head;
  char *tail;
  unsigned int num_real_links;
  hb_subset_serialize_link_t *real_links;
  unsigned int num_virtual_links;
  hb_subset_serialize_link_t *virtual_links;
} hb_subset_serialize_object_t;

HB_EXTERN hb_blob_t *
hb_subset_serialize_or_fail (hb_tag_t                      table_tag,
                             hb_subset_serialize_object_t *hb_objects,
                             unsigned                      num_hb_objs);


HB_END_DECLS

#endif /* HB_SUBSET_SERIALIZE_H */