/*

 * Copyright © 2012,2018  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.

 *

 * Google Author(s): Behdad Esfahbod

 */

#ifndef HB_SHAPE_PLAN_HH

#define HB_SHAPE_PLAN_HH

#include "hb.hh"

#include "hb-shaper.hh"

#include "hb-ot-shape.hh"

struct hb_shape_plan_key_t

{

  hb_segment_properties_t  props;

  const hb_feature_t      *user_features;

  unsigned int             num_user_features;

#ifndef HB_NO_OT_SHAPE

  hb_ot_shape_plan_key_t   ot;

#endif

  hb_shape_func_t         *shaper_func;

  const char              *shaper_name;

  HB_INTERNAL bool init (bool                           copy,

       hb_face_t                     *face,

       const hb_segment_properties_t *props,

       const hb_feature_t            *user_features,

       unsigned int                   num_user_features,

       const int                     *coords,

       unsigned int                   num_coords,

       const char * const            *shaper_list);

  HB_INTERNAL void fini () { hb_free ((void *) user_features); user_features = nullptr; }

  HB_INTERNAL bool user_features_match (const hb_shape_plan_key_t *other);

  HB_INTERNAL bool equal (const hb_shape_plan_key_t *other);

};

struct hb_shape_plan_t

{

  HB_INTERNAL ~hb_shape_plan_t ();

  hb_object_header_t header;

  hb_face_t *face_unsafe; /* We don't carry a reference to face. */

  hb_shape_plan_key_t key;

#ifndef HB_NO_OT_SHAPE

  hb_ot_shape_plan_t ot;

#endif

#ifdef HAVE_HARFRUST

  hb_atomic_t<void *> harfrust_data;

#endif

};

#endif /* HB_SHAPE_PLAN_HH */