% ----------------------------------------------------------------------------
% the XSIM package
% 
%   eXercise Sheets IMproved
% 
% ----------------------------------------------------------------------------
% Clemens Niederberger
% Web:    https://github.com/cgnieder/xsim
% E-Mail: contact@mychemistry.eu
% ----------------------------------------------------------------------------
% Copyright 2017--2020 Clemens Niederberger
% 
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
% 
% This work has the LPPL maintenance status `maintained'.
% 
% The Current Maintainer of this work is Clemens Niederberger.
% ----------------------------------------------------------------------------
% If you have any ideas, questions, suggestions or bugs to report, please
% feel free to contact me.
% ----------------------------------------------------------------------------
\RequirePackage {expl3,xparse,l3keys2e}

\ExplSyntaxOn

\tl_const:Nn \c_xsim_date_tl                 {2020/02/23}
\tl_const:Nn \c_xsim_version_major_number_tl {0}
\tl_const:Nn \c_xsim_version_minor_number_tl {18}
\tl_const:Nn \c_xsim_version_subrelease_tl   {}
\tl_const:Nx \c_xsim_version_number_tl
  {
    \c_xsim_version_major_number_tl .
    \c_xsim_version_minor_number_tl
  }
\tl_const:Nx \c_xsim_version_tl
  {
    \c_xsim_version_number_tl
    \c_xsim_version_subrelease_tl
  }
\tl_const:Nn \c_xsim_info_tl {eXercise ~ Sheets ~ IMproved}

\ProvidesExplPackage
  {xsim}
  {\c_xsim_date_tl}
  {\c_xsim_version_tl}
  {\c_xsim_info_tl}

% --------------------------------------------------------------------------

% options, information

\bool_new:N \g__xsim_final_bool
\bool_new:N \g__xsim_verbose_bool
\bool_new:N \g_xsim_clear_aux_bool
\bool_new:N \g__xsim_write_to_file_bool
\bool_new:N \g_xsim_use_aux_bool
\bool_new:N \g__xsim_rerun_bool
\bool_new:N \g__xsim_blank_bool

\keys_define:nn {xsim/package}
  {
    final     .bool_gset:N         = \g__xsim_final_bool ,
    verbose   .bool_gset:N         = \g__xsim_verbose_bool ,
    clear-aux .bool_gset:N         = \g_xsim_clear_aux_bool ,
    no-files  .bool_gset_inverse:N = \g__xsim_write_to_file_bool ,
    no-files  .initial:n           = false ,
    use-aux   .bool_gset:N         = \g_xsim_use_aux_bool ,
    use-aux   .initial:n           = false ,
    blank     .bool_gset:N         = \g__xsim_blank_bool ,
    blank     .initial:n           = false
  }

\ProcessKeysPackageOptions {xsim/package}

\keys_define:nn {xsim/package}
  {
    final     .code:n = \msg_error:nnn {xsim} {load-time-option} {final} ,
    verbose   .code:n = \msg_error:nnn {xsim} {load-time-option} {verbose} ,
    clear-aux .code:n = \msg_error:nnn {xsim} {load-time-option} {clear-aux} ,
    no-files  .code:n = \msg_error:nnn {xsim} {load-time-option} {no-files} ,
    use-aux   .code:n = \msg_error:nnn {xsim} {load-time-option} {use-aux} ,
    blank     .code:n = \msg_error:nnn {xsim} {load-time-option} {blank}
  }

% --------------------------------------------------------------------------

% messages:
\msg_new:nnn {xsim} {load-time-option}
  {
    `#1'~ is~ a~ load-time~ option! \\
    You~ cannot~ set~ it~ with~ \token_to_str:N \xsimsetup ! \\
    You~ need~ to~ use~ \token_to_str:N \usepackage [#1] {xsim} .
  }

\msg_new:nnn {xsim} {rerun}
  {
    Exercise~ properties~ may~ have~ changed.~ Rerun~ to~ get~ them~
    synchronized.
  }

\msg_new:nnn {xsim} {verbose} { #1 ~( \msg_line_context: ) }

% --------------------------------------------------------------------------

\cs_new_protected:Npn \xsim_do_rerun:
  { \xsim_if_rerun:T { \msg_warning:nn {xsim} {rerun} } }

% --------------------------------------------------------------------------

% load module mechanism:
\tl_set:Nn \l_tmpa_tl {code.tex}
\@onefilewithoptions {xsim.modules} [][] \l_tmpa_tl

% --------------------------------------------------------------------------
\xsim_load_modules:n {definitions}

\AtEndDocument
  {
    \xsim_do_rerun:
    \xsim_close_aux:
  }

% --------------------------------------------------------------------------
\file_input_stop:
  
2020/02/20 - implement issue #31 (blank package option)
2020/02/21 - don't allow package options to be set with \xsimsetup
