hb-shape-plan.h

   1 /*
   2  * Copyright © 2012  Google, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Google Author(s): Behdad Esfahbod
  25  */
  26
  27 #ifndef HB_H_IN
  28 #error "Include <hb.h> instead."
  29 #endif
  30
  31 #ifndef HB_SHAPE_PLAN_H
  32 #define HB_SHAPE_PLAN_H
  33
  34 #include "hb-common.h"
  35 #include "hb-font.h"
  36
  37 HB_BEGIN_DECLS
  38
  39 typedef struct hb_shape_plan_t hb_shape_plan_t;
  40
  41 HB_EXTERN hb_shape_plan_t *
  42 hb_shape_plan_create (hb_face_t                     *face,
  43                       const hb_segment_properties_t *props,
  44                       const hb_feature_t            *user_features,
  45                       unsigned int                   num_user_features,
  46                       const char * const            *shaper_list);
  47
  48 HB_EXTERN hb_shape_plan_t *
  49 hb_shape_plan_create_cached (hb_face_t                     *face,
  50                              const hb_segment_properties_t *props,
  51                              const hb_feature_t            *user_features,
  52                              unsigned int                   num_user_features,
  53                              const char * const            *shaper_list);
  54
  55 HB_EXTERN hb_shape_plan_t *
  56 hb_shape_plan_get_empty (void);
  57
  58 HB_EXTERN hb_shape_plan_t *
  59 hb_shape_plan_reference (hb_shape_plan_t *shape_plan);
  60
  61 HB_EXTERN void
  62 hb_shape_plan_destroy (hb_shape_plan_t *shape_plan);
  63
  64 HB_EXTERN hb_bool_t
  65 hb_shape_plan_set_user_data (hb_shape_plan_t    *shape_plan,
  66                              hb_user_data_key_t *key,
  67                              void *              data,
  68                              hb_destroy_func_t   destroy,
  69                              hb_bool_t           replace);
  70
  71 HB_EXTERN void *
  72 hb_shape_plan_get_user_data (hb_shape_plan_t    *shape_plan,
  73                              hb_user_data_key_t *key);
  74
  75
  76 HB_EXTERN hb_bool_t
  77 hb_shape_plan_execute (hb_shape_plan_t    *shape_plan,
  78                        hb_font_t          *font,
  79                        hb_buffer_t        *buffer,
  80                        const hb_feature_t *features,
  81                        unsigned int        num_features);
  82
  83 HB_EXTERN const char *
  84 hb_shape_plan_get_shaper (hb_shape_plan_t *shape_plan);
  85
  86
  87 HB_END_DECLS
  88
  89 #endif /* HB_SHAPE_PLAN_H */