hb-shape-plan.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  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. #if !defined(HB_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
  27. #error "Include <hb.h> instead."
  28. #endif
  29. #ifndef HB_SHAPE_PLAN_H
  30. #define HB_SHAPE_PLAN_H
  31. #include "hb-common.h"
  32. #include "hb-font.h"
  33. HB_BEGIN_DECLS
  34. /**
  35. * hb_shape_plan_t:
  36. *
  37. * Data type for holding a shaping plan.
  38. *
  39. * Shape plans contain information about how HarfBuzz will shape a
  40. * particular text segment, based on the segment's properties and the
  41. * capabilities in the font face in use.
  42. *
  43. * Shape plans can be queried about how shaping will perform, given a set
  44. * of specific input parameters (script, language, direction, features,
  45. * etc.).
  46. *
  47. **/
  48. typedef struct hb_shape_plan_t hb_shape_plan_t;
  49. HB_EXTERN hb_shape_plan_t *
  50. hb_shape_plan_create (hb_face_t *face,
  51. const hb_segment_properties_t *props,
  52. const hb_feature_t *user_features,
  53. unsigned int num_user_features,
  54. const char * const *shaper_list);
  55. HB_EXTERN hb_shape_plan_t *
  56. hb_shape_plan_create_cached (hb_face_t *face,
  57. const hb_segment_properties_t *props,
  58. const hb_feature_t *user_features,
  59. unsigned int num_user_features,
  60. const char * const *shaper_list);
  61. HB_EXTERN hb_shape_plan_t *
  62. hb_shape_plan_create2 (hb_face_t *face,
  63. const hb_segment_properties_t *props,
  64. const hb_feature_t *user_features,
  65. unsigned int num_user_features,
  66. const int *coords,
  67. unsigned int num_coords,
  68. const char * const *shaper_list);
  69. HB_EXTERN hb_shape_plan_t *
  70. hb_shape_plan_create_cached2 (hb_face_t *face,
  71. const hb_segment_properties_t *props,
  72. const hb_feature_t *user_features,
  73. unsigned int num_user_features,
  74. const int *coords,
  75. unsigned int num_coords,
  76. const char * const *shaper_list);
  77. HB_EXTERN hb_shape_plan_t *
  78. hb_shape_plan_get_empty (void);
  79. HB_EXTERN hb_shape_plan_t *
  80. hb_shape_plan_reference (hb_shape_plan_t *shape_plan);
  81. HB_EXTERN void
  82. hb_shape_plan_destroy (hb_shape_plan_t *shape_plan);
  83. HB_EXTERN hb_bool_t
  84. hb_shape_plan_set_user_data (hb_shape_plan_t *shape_plan,
  85. hb_user_data_key_t *key,
  86. void * data,
  87. hb_destroy_func_t destroy,
  88. hb_bool_t replace);
  89. HB_EXTERN void *
  90. hb_shape_plan_get_user_data (const hb_shape_plan_t *shape_plan,
  91. hb_user_data_key_t *key);
  92. HB_EXTERN hb_bool_t
  93. hb_shape_plan_execute (hb_shape_plan_t *shape_plan,
  94. hb_font_t *font,
  95. hb_buffer_t *buffer,
  96. const hb_feature_t *features,
  97. unsigned int num_features);
  98. HB_EXTERN const char *
  99. hb_shape_plan_get_shaper (hb_shape_plan_t *shape_plan);
  100. HB_END_DECLS
  101. #endif /* HB_SHAPE_PLAN_H */