jpayne@69: /*
jpayne@69:  * Copyright © 2012  Google, Inc.
jpayne@69:  *
jpayne@69:  *  This is part of HarfBuzz, a text shaping library.
jpayne@69:  *
jpayne@69:  * Permission is hereby granted, without written agreement and without
jpayne@69:  * license or royalty fees, to use, copy, modify, and distribute this
jpayne@69:  * software and its documentation for any purpose, provided that the
jpayne@69:  * above copyright notice and the following two paragraphs appear in
jpayne@69:  * all copies of this software.
jpayne@69:  *
jpayne@69:  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
jpayne@69:  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
jpayne@69:  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
jpayne@69:  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
jpayne@69:  * DAMAGE.
jpayne@69:  *
jpayne@69:  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
jpayne@69:  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
jpayne@69:  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
jpayne@69:  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
jpayne@69:  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
jpayne@69:  *
jpayne@69:  * Google Author(s): Behdad Esfahbod
jpayne@69:  */
jpayne@69: 
jpayne@69: #ifndef HB_H_IN
jpayne@69: #error "Include <hb.h> instead."
jpayne@69: #endif
jpayne@69: 
jpayne@69: #ifndef HB_SHAPE_PLAN_H
jpayne@69: #define HB_SHAPE_PLAN_H
jpayne@69: 
jpayne@69: #include "hb-common.h"
jpayne@69: #include "hb-font.h"
jpayne@69: 
jpayne@69: HB_BEGIN_DECLS
jpayne@69: 
jpayne@69: typedef struct hb_shape_plan_t hb_shape_plan_t;
jpayne@69: 
jpayne@69: HB_EXTERN hb_shape_plan_t *
jpayne@69: hb_shape_plan_create (hb_face_t                     *face,
jpayne@69: 		      const hb_segment_properties_t *props,
jpayne@69: 		      const hb_feature_t            *user_features,
jpayne@69: 		      unsigned int                   num_user_features,
jpayne@69: 		      const char * const            *shaper_list);
jpayne@69: 
jpayne@69: HB_EXTERN hb_shape_plan_t *
jpayne@69: hb_shape_plan_create_cached (hb_face_t                     *face,
jpayne@69: 			     const hb_segment_properties_t *props,
jpayne@69: 			     const hb_feature_t            *user_features,
jpayne@69: 			     unsigned int                   num_user_features,
jpayne@69: 			     const char * const            *shaper_list);
jpayne@69: 
jpayne@69: HB_EXTERN hb_shape_plan_t *
jpayne@69: hb_shape_plan_create2 (hb_face_t                     *face,
jpayne@69: 		       const hb_segment_properties_t *props,
jpayne@69: 		       const hb_feature_t            *user_features,
jpayne@69: 		       unsigned int                   num_user_features,
jpayne@69: 		       const int                     *coords,
jpayne@69: 		       unsigned int                   num_coords,
jpayne@69: 		       const char * const            *shaper_list);
jpayne@69: 
jpayne@69: HB_EXTERN hb_shape_plan_t *
jpayne@69: hb_shape_plan_create_cached2 (hb_face_t                     *face,
jpayne@69: 			      const hb_segment_properties_t *props,
jpayne@69: 			      const hb_feature_t            *user_features,
jpayne@69: 			      unsigned int                   num_user_features,
jpayne@69: 			      const int                     *coords,
jpayne@69: 			      unsigned int                   num_coords,
jpayne@69: 			      const char * const            *shaper_list);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_EXTERN hb_shape_plan_t *
jpayne@69: hb_shape_plan_get_empty (void);
jpayne@69: 
jpayne@69: HB_EXTERN hb_shape_plan_t *
jpayne@69: hb_shape_plan_reference (hb_shape_plan_t *shape_plan);
jpayne@69: 
jpayne@69: HB_EXTERN void
jpayne@69: hb_shape_plan_destroy (hb_shape_plan_t *shape_plan);
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_shape_plan_set_user_data (hb_shape_plan_t    *shape_plan,
jpayne@69: 			     hb_user_data_key_t *key,
jpayne@69: 			     void *              data,
jpayne@69: 			     hb_destroy_func_t   destroy,
jpayne@69: 			     hb_bool_t           replace);
jpayne@69: 
jpayne@69: HB_EXTERN void *
jpayne@69: hb_shape_plan_get_user_data (hb_shape_plan_t    *shape_plan,
jpayne@69: 			     hb_user_data_key_t *key);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_EXTERN hb_bool_t
jpayne@69: hb_shape_plan_execute (hb_shape_plan_t    *shape_plan,
jpayne@69: 		       hb_font_t          *font,
jpayne@69: 		       hb_buffer_t        *buffer,
jpayne@69: 		       const hb_feature_t *features,
jpayne@69: 		       unsigned int        num_features);
jpayne@69: 
jpayne@69: HB_EXTERN const char *
jpayne@69: hb_shape_plan_get_shaper (hb_shape_plan_t *shape_plan);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_END_DECLS
jpayne@69: 
jpayne@69: #endif /* HB_SHAPE_PLAN_H */