
/******************************************************************************
* MODULE     : env.hpp
* DESCRIPTION: edit environment for typesetting
* COPYRIGHT  : (C) 1999  Joris van der Hoeven
*******************************************************************************
* This software falls under the GNU general public license version 3 or later.
* It comes WITHOUT ANY WARRANTY WHATSOEVER. For details, see the file LICENSE
* in the root directory or <http://www.gnu.org/licenses/gpl-3.0.html>.
******************************************************************************/

#ifndef ENV_H
#define ENV_H
#include "vars.hpp"
#include "drd_info.hpp"
#include "gui.hpp"
#include "font.hpp"
#include "language.hpp"
#include "path.hpp"
#include "hashmap.hpp"
#include "boxes.hpp"
#include "url.hpp"
#include "frame.hpp"
#include "link.hpp"
#include "player.hpp"

#define DECORATION (-1)

/******************************************************************************
* The different types of system environment variables
******************************************************************************/

#define Env_User               0
#define Env_Fixed              1
#define Env_Zoom               2
#define Env_Magnification      3
#define Env_Magnify            4
#define Env_Language           5
#define Env_Mode               6
#define Env_Info_Level         7
#define Env_Font               8
#define Env_Font_Size          9
#define Env_Font_Sizes        10
#define Env_Index_Level       11
#define Env_Display_Style     12
#define Env_Math_Condensed    13
#define Env_Vertical_Pos      14
#define Env_Math_Nesting      15
#define Env_Math_Width        16
#define Env_Color             17
#define Env_Pattern_Mode      18
#define Env_Spacing           19
#define Env_Paragraph         20
#define Env_Page              21
#define Env_Page_Extents      22
#define Env_Preamble          23
#define Env_Geometry          24
#define Env_Frame             25
#define Env_Line_Width        26
#define Env_Grid              27
#define Env_Grid_Aspect       28
#define Env_Src_Style         29
#define Env_Src_Special       30
#define Env_Src_Compact       31
#define Env_Src_Close         32
#define Env_Src_Color         33
#define Env_Point_Style       34
#define Env_Point_Size        35
#define Env_Dash_Style        36
#define Env_Dash_Style_Unit   37
#define Env_Fill_Color        38
#define Env_Line_Arrows       39
#define Env_Line_Portion      40
#define Env_Text_At_Halign    41
#define Env_Text_At_Valign    42
#define Env_Doc_At_Valign     43

/******************************************************************************
* For style file editing
******************************************************************************/

#define STYLE_ANGULAR         0
#define STYLE_SCHEME          1
#define STYLE_LATEX           2
#define STYLE_FUNCTIONAL      3

#define SPECIAL_RAW           0
#define SPECIAL_FORMAT        1
#define SPECIAL_NORMAL        2
#define SPECIAL_MAXIMAL       3

#define COMPACT_ALL           0
#define COMPACT_INLINE_ARGS   1
#define COMPACT_INLINE_START  2
#define COMPACT_INLINE        3
#define COMPACT_NONE          4

#define CLOSE_MINIMAL         0
#define CLOSE_COMPACT         1
#define CLOSE_LONG            2
#define CLOSE_REPEAT          3

#define INACTIVE_INLINE_RECURSE  0
#define INACTIVE_INLINE_ONCE     1
#define INACTIVE_INLINE_ERROR    2
#define INACTIVE_BLOCK_RECURSE   3
#define INACTIVE_BLOCK_ONCE      4
#define INACTIVE_BLOCK_ERROR     5

/******************************************************************************
* Other enumerated values
******************************************************************************/

#define INFO_NONE          0
#define INFO_MINIMAL       1
#define INFO_SHORT         2
#define INFO_DETAILED      3
#define INFO_PAPER         4
#define INFO_SHORT_PAPER   5

/******************************************************************************
* The edit environment
******************************************************************************/

class edit_env;
class ornament_parameters;
class art_box_parameters;
class edit_env_rep: public concrete_struct {
public:
  drd_info&                    drd;
private:
  hashmap<string,tree>         env;
  hashmap<string,tree>         back;
public:
  hashmap<string,path>         src;
  list<hashmap<string,tree> >  macro_arg;
  list<hashmap<string,path> >  macro_src;
  array<box>                   decorated_boxes;

  hashmap<string,int>&         var_type;
  url                          base_file_name;
  url                          cur_file_name;
  bool                         secure;
  hashmap<string,tree>&        local_ref;
  hashmap<string,tree>&        global_ref;
  hashmap<string,tree>&        local_aux;
  hashmap<string,tree>&        global_aux;
  hashmap<string,tree>&        local_att;
  hashmap<string,tree>&        global_att;
  bool                         complete;    // typeset complete document ?
  bool                         read_only;   // write-protected ?
  hashmap<string,tree>         missing;     // missing refs
  array<tree>                  redefined;   // redefined labels
  hashmap<string,bool>         touched;     // touched refs
  link_repository              link_env;    // current links
  array<array<int> >           size_cache;  // math font size cache

  int          dpi;
  double       inch;
  double       zoomf;
  SI           pixel;
  double       magn;
  double       mgfy;
  double       flexibility;
  int          first_page;
  int          mode;
  int          mode_op;
  language     lan;
  int          hl_lan;
  font         fn;
  int          fn_size;
  int          index_level;
  bool         display_style;
  bool         math_condensed;
  int          vert_pos;
  SI           frac_max;
  SI           table_max;
  pencil       flatten_pen;
  int          alpha;
  pencil       pen;
  bool         no_patterns;
  bool         preamble;
  int          spacing_policy;
  tree         math_font_sizes;
  int          nesting_level;

  int          info_level;
  int          src_style;
  int          src_special;
  int          src_compact;
  int          src_close;
  string       src_tag_color;
  color        src_tag_col;
  int          inactive_mode;
  tree         recover_env;

  double       anim_start;
  double       anim_end;
  double       anim_portion;

  SI           gw;
  SI           gh;
  string       gvalign;
  frame        fr;
  point        clip_lim1;
  point        clip_lim2;
  string       point_style;
  SI           point_size;
  SI           point_border;
  array<bool>  dash_style;
  array<point> dash_motif;
  SI           dash_style_unit;
  double       dash_style_ratio;
  brush        fill_brush;
  array<tree>  line_arrows;
  double       line_portion;
  string       text_at_halign;
  string       text_at_valign;
  string       doc_at_valign;

  string       page_type;
  string       page_real_type;
  bool         page_landscape;
  bool         page_automatic;
  bool         page_single;
  bool         page_floats;
  int          page_packet;
  int          page_offset;
  tree         page_border;
  int          page_margin_mode;
  SI           page_width;
  SI           page_height;
  SI           page_real_width;
  SI           page_real_height;
  SI           page_user_width;
  SI           page_user_height;
  SI           page_odd_margin;
  SI           page_even_margin;
  SI           page_right_margin;
  SI           page_top_margin;
  SI           page_bottom_margin;

private:
  tree exec_formatting (tree t, string v);
  void exec_until_formatting (tree t, path p, string v);
  bool exec_until_formatting (tree t, path p, string var, int l, string v);
  tree exec_table (tree t);
  void exec_until_table (tree t, path p);
  bool exec_until_table (tree t, path p, string var, int level);
  tree exec_assign (tree t);
  tree exec_provide (tree t);
  tree exec_with (tree t);
  void exec_until_with (tree t, path p);
  bool exec_until_with (tree t, path p, string var, int level);
  tree exec_drd_props (tree t);
  tree exec_compound (tree t);
  void exec_until_compound (tree t, path p);
  bool exec_until_compound (tree t, path p, string var, int level);
  tree exec_provides (tree t);
  tree exec_value (tree t);
  tree exec_quote_value (tree t);
  tree exec_or_value (tree t);
  tree exec_arg (tree t);
  bool exec_until_arg (tree t, path p, string var, int level);
  tree exec_quote_arg (tree t);
  tree exec_get_label (tree t);
  tree exec_get_arity (tree t);
  tree exec_new_theme (tree t);
  tree exec_copy_theme (tree t);
  tree exec_apply_theme_sub (string var);
  tree exec_apply_theme (tree t);
  tree exec_select_theme_sub (string theme, string from);
  tree exec_select_theme (tree t);
  tree exec_eval_args (tree t);
  bool exec_until_mark (tree t, path p, string var, int level);
  bool exec_until_quasi (tree t, path p, string var, int level);
  tree exec_quasiquoted (tree t);
  tree exec_copy (tree t);
  tree exec_if (tree t);
  bool exec_until_if (tree t, path p, string var, int level);
  tree exec_case (tree t);
  bool exec_until_case (tree t, path p, string var, int level);
  tree exec_while (tree t);
  bool exec_until_while (tree t, path p, string var, int level);
  tree exec_for_each (tree t);
  tree exec_use_package (tree t);
  tree exec_use_module (tree t);

  tree exec_or (tree t);
  tree exec_xor (tree t);
  tree exec_and (tree t);
  tree exec_not (tree t);
  tree exec_plus_minus (tree t);
  tree exec_min_max (tree t);
  tree exec_times_over (tree t);
  tree exec_divide (tree t);
  tree exec_modulo (tree t);
  tree exec_math_sqrt (tree t);
  tree exec_exp (tree t);
  tree exec_log (tree t);
  tree exec_pow (tree t);
  tree exec_cos (tree t);
  tree exec_sin (tree t);
  tree exec_tan (tree t);
  tree exec_merge (tree t);
  tree exec_length (tree t);
  tree exec_range (tree t);
  tree exec_number (tree t);
  tree exec_date (tree t);
  tree exec_translate (tree t);
  tree exec_change_case (tree t, tree nc, bool exec_flag, bool first);
  tree exec_change_case (tree t);
  tree exec_find_file (tree t);
  tree exec_find_file_upwards (tree t);
  tree exec_is_tuple (tree t);
  tree exec_lookup (tree t);
  tree exec_arg_recursive (tree t);
  tree exec_occurs_inside (tree t);
  tree exec_equal (tree t);
  tree exec_unequal (tree t);
  tree exec_less (tree t);
  tree exec_lesseq (tree t);
  tree exec_greater (tree t);
  tree exec_greatereq (tree t);
  tree exec_blend (tree t);

  tree exec_cm_length ();
  tree exec_mm_length ();
  tree exec_in_length ();
  tree exec_pt_length ();
  tree exec_bp_length ();
  tree exec_dd_length ();
  tree exec_pc_length ();
  tree exec_cc_length ();
  tree exec_fs_length ();
  tree exec_fbs_length ();
  tree exec_em_length ();
  tree exec_ln_length ();
  tree exec_sep_length ();
  tree exec_yfrac_length ();
  tree exec_ex_length ();
  tree exec_fn_length ();
  tree exec_fns_length ();
  tree exec_bls_length ();
  tree exec_fnbot_length ();
  tree exec_fntop_length ();
  tree exec_spc_length ();
  tree exec_xspc_length ();
  tree exec_par_length ();
  tree exec_pag_length ();
  tree exec_gw_length ();
  tree exec_gh_length ();
  tree exec_gu_length ();
  tree exec_tmpt_length ();
  tree exec_px_length ();
  tree exec_lcorner_length ();
  tree exec_bcorner_length ();
  tree exec_rcorner_length ();
  tree exec_tcorner_length ();
  tree exec_ms_length ();
  tree exec_s_length ();
  tree exec_msec_length ();
  tree exec_sec_length ();
  tree exec_min_length ();
  tree exec_hr_length ();

  tree exec_hard_id (tree t);
  tree exec_script (tree t);
  tree exec_find_accessible (tree t);
  tree exec_set_binding (tree t);
  tree exec_get_binding (tree t);
  tree exec_has_binding (tree t);
  tree exec_get_attachment (tree t);

  tree exec_pattern (tree t);

  tree exec_anim_static (tree t);
  tree exec_anim_dynamic (tree t);
  tree exec_morph (tree t);
  tree exec_anim_time ();
  tree exec_anim_portion ();

  tree exec_point (tree t);

  tree exec_eff_move (tree t);
  tree exec_eff_magnify (tree t);
  tree exec_eff_bubble (tree t);
  tree exec_eff_crop (tree t);
  tree exec_eff_turbulence (tree t);
  tree exec_eff_fractal_noise (tree t);
  tree exec_eff_hatch (tree t);
  tree exec_eff_dots (tree t);
  tree exec_eff_gaussian (tree t);
  tree exec_eff_oval (tree t);
  tree exec_eff_rectangular (tree t);
  tree exec_eff_motion (tree t);
  tree exec_eff_degrade (tree t);
  tree exec_eff_distort (tree t);
  tree exec_eff_gnaw (tree t);

  tree exec_box_info (tree t);
  tree exec_frame_direct (tree t);
  tree exec_frame_inverse (tree t);

  tree exec_rewrite (tree t);
  bool exec_until_rewrite (tree t, path p, string var, int level);
  tree rewrite_inactive_arg (tree t, tree var, int i, bool bl, bool fl);
  tree rewrite_inactive_raw_data (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive_document (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive_concat (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive_value (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive_arg (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive_style_with (tree t, tree var, bool b, bool f, bool o);
  tree rewrite_inactive_active (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive_var_active (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive_symbol (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive_hybrid (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive_default (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive (tree t, tree var, bool block, bool flush);
  tree rewrite_inactive (tree t, tree var);

public:
  edit_env_rep (drd_info& drd,
		url base_file_name,
		hashmap<string,tree>& local_ref,
		hashmap<string,tree>& global_ref,
		hashmap<string,tree>& local_aux,
		hashmap<string,tree>& global_aux,
		hashmap<string,tree>& local_att,
		hashmap<string,tree>& global_att);
  void   style_init_env ();

  /* execution of trees and setting environment variables */
  tree   exec (tree t);
  void   exec_until (tree t, path p);
  bool   exec_until (tree t, path p, string var, int level);
  string exec_string (tree t);        /* should be inline */
  tree   expand (tree t, bool search_accessible= false);
  bool   depends (tree t, string s, int level);
  tree   rewrite (tree t);
  path   get_animation_ip (path ip);
  tree   animate (tree t);
  tree   checkout_animation (tree t);
  tree   commit_animation (tree t);
  tree   expand_morph (tree t);

  inline void monitored_write (string s, tree t) {
    back->write_back (s, env); env (s)= t; }
  inline void monitored_write_update (string s, tree t) {
    back->write_back (s, env); env (s)= t; update (s); }
  inline void write (string s, tree t) { env (s)= t; }
  inline void write_update (string s, tree t) { env (s)= t; update (s); }
  inline tree local_begin (string s, tree t) {
    // tree r (env [s]); monitored_write_update (s, t); return r;
    tree& val= env (s); tree r (val); val= t; update (s); return r; }
  inline void local_end (string s, tree t) {
     env (s)= t; update (s); }
  inline tree local_begin_script () {
    return local_begin (MATH_LEVEL, as_string (index_level+1)); }
  inline void local_end_script (tree t) {
    local_end (MATH_LEVEL, t); }
  inline void assign (string s, tree t) {
    tree& val= env (s); t= exec(t); if (val != t) {
      back->write_back (s, env); val= t; update (s); } }
  inline bool provides (string s) { return env->contains (s); }
  inline tree read (string s) { return env [s]; }
  tree local_begin_extents (box b);
  void local_end_extents (tree t);

  void write_default_env ();
  void write_env (hashmap<string,tree> user_env);
  void monitored_patch_env (hashmap<string,tree> patch);
  void patch_env (hashmap<string,tree> patch);
  void read_env (hashmap<string,tree>& ret);
  void local_start (hashmap<string,tree>& prev_back);
  void local_update (hashmap<string,tree>& oldpat, hashmap<string,tree>& chg);
  void local_end (hashmap<string,tree>& prev_back);

  /* updating environment variables */
  ornament_parameters get_ornament_parameters ();
  art_box_parameters get_art_box_parameters (tree t);
  void   update_page_pars ();
  void   get_page_pars (SI& w, SI& h, SI& ww, SI& hh,
			SI& odd, SI& even, SI& top, SI& bottom);
  SI     get_page_width (bool deco);
  SI     get_pages_width (bool deco);
  SI     get_page_height (bool deco);
  tree   decode_arrow (tree t, string l, string h);
  int    get_script_size (int sz, int level);
  void   update_font ();
  void   update_color ();
  void   update_pattern_mode ();
  void   update_mode ();
  void   update_info_level ();
  void   update_language ();
  void   update_geometry ();
  void   update_frame ();
  void   update_src_style ();
  void   update_src_special ();
  void   update_src_compact ();
  void   update_src_close ();
  void   update_dash_style ();
  void   update_dash_style_unit ();
  void   update_line_arrows ();
  void   update ();
  void   update (string env_var);

  /* lengths */
  bool      is_length (string s);
  bool      is_anylen (tree t);
  tree      tmlen_plus (tree t1, tree t2);
  tree      tmlen_min (tree t1, tree t2);
  tree      tmlen_max (tree t1, tree t2);
  tree      tmlen_times (double sc, tree t);
  tree      tmlen_over (tree t1, tree t2);
  double    tmlen_div (tree t1, tree t2);
  tree      tmlen_mod (tree t1, tree t2);

  void      get_length_unit (string l, SI& un, string& un_str);
  string    add_lengths (string l1, string l2);
  string    multiply_length (double x, string l);
  double    divide_lengths (string l1, string l2);

  tree      as_tmlen (tree t);
  SI        as_length (tree t);
  SI        as_length (tree t, string perc);
  SI        as_eff_length (tree t);
  space     as_hspace (tree t);
  space     as_vspace (tree t);
  point     as_point (tree t);

  /* retrieving environment variables */
  inline bool get_bool (string var) {
    tree t= env [var];
    if (is_compound (t)) return false;
    return as_bool (t->label); }
  inline int get_int (string var) {
    tree t= env [var];
    if (is_compound (t)) return 0;
    return as_int (t->label); }
  inline double get_double (string var) {
    tree t= env [var];
    if (is_compound (t)) return 0.0;
    return as_double (t->label); }
  inline string get_string (string var) {
    tree t= env [var];
    if (is_compound (t)) return "";
    return t->label; }
  inline SI get_length (string var) {
    tree t= env [var];
    return as_length (t); }
  inline space get_vspace (string var) {
    tree t= env [var];
    return as_vspace (t); }
  inline color get_color (string var) {
    tree t= env [var];
    return named_color (as_string (t), alpha); }

  friend class edit_env;
  friend tm_ostream& operator << (tm_ostream& out, edit_env env);
};

class edit_env {
  CONCRETE_NULL(edit_env);
  inline edit_env (edit_env_rep* rep2):
    rep(rep2) { INC_COUNT_NULL (this->rep); }
  edit_env (drd_info& drd,
	    url base_file_name,
	    hashmap<string,tree>& local_ref,
	    hashmap<string,tree>& global_ref,
	    hashmap<string,tree>& local_aux,
	    hashmap<string,tree>& global_aux,
	    hashmap<string,tree>& local_att,
	    hashmap<string,tree>& global_att);
};
CONCRETE_NULL_CODE(edit_env);

tm_ostream& operator << (tm_ostream& out, edit_env env);
tree texmacs_exec (edit_env env, tree cmd);
tree load_inclusion (url u); // implemented in tm_file.cpp
tree tree_extents (tree t);
bool is_percentage (tree t, string s);
bool is_percentage (tree t);
double as_percentage (tree t);
bool is_magnification (string s);
double get_magnification (string s);
int decode_alpha (string s);
array<double> get_control_times (tree t);

void set_graphical_value (tree var, tree val);
bool has_graphical_value (tree var);
tree get_graphical_value (tree var);
bool graphics_needs_update ();
void graphics_require_update (tree var);
void graphics_notify_update (tree var);

void players_set_elapsed (tree t, double el);
void players_set_speed (tree t, double sp);

#endif // defined ENV_H
