hb-shape-plan.h revision 2f87cebe1062c7007021ebd05c1664e60da80825 
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_SHAPE_PLAN_H
28#define HB_SHAPE_PLAN_H
29
30/* TODO To become public one day */
31
32#include "hb-private.hh"
33
34#include "hb-buffer-private.hh"
35
36
37typedef struct hb_shape_plan_t hb_shape_plan;
38
39/*
40 * hb_shape_plan_t
41 */
42
43HB_INTERNAL hb_shape_plan_t *
44hb_shape_plan_create (hb_face_t                     *face,
45		      const hb_segment_properties_t *props,
46		      const hb_feature_t            *user_features,
47		      unsigned int                   num_user_features,
48		      const char * const            *shaper_list);
49
50hb_shape_plan_t *
51hb_shape_plan_create_cached (hb_face_t                     *face,
52			     const hb_segment_properties_t *props,
53			     const hb_feature_t            *user_features,
54			     unsigned int                   num_user_features,
55			     const char * const            *shaper_list);
56
57HB_INTERNAL hb_shape_plan_t *
58hb_shape_plan_get_empty (void);
59
60HB_INTERNAL hb_shape_plan_t *
61hb_shape_plan_reference (hb_shape_plan_t *shape_plan);
62
63HB_INTERNAL void
64hb_shape_plan_destroy (hb_shape_plan_t *shape_plan);
65
66
67HB_INTERNAL hb_bool_t
68hb_shape_plan_execute (hb_shape_plan      *shape_plan,
69		       hb_font_t          *font,
70		       hb_buffer_t        *buffer,
71		       const hb_feature_t *features,
72		       unsigned int        num_features);
73
74
75#endif /* HB_SHAPE_PLAN_H */
76