src/Tools/isac/TODO.thy
author Walther Neuper <walther.neuper@jku.at>
Mon, 04 May 2020 17:08:32 +0200
changeset 59939 7ad15af2297c
parent 59938 46b6479cefa7
child 59943 4816df44437f
permissions -rw-r--r--
separate struct O_Model and I_Model, part 1
     1 (* Title:  todo's for isac core
     2    Author: Walther Neuper 111013
     3    (c) copyright due to lincense terms.
     4 *)
     5 theory TODO
     6 imports "~~/src/Doc/Prog_Prove/LaTeXsugar"
     7 begin
     8 
     9 text \<open>
    10 Legend: here + code since 200120
    11   \<open>(*DOC\<close> identifies stuff dedicated for isac/Doc/Lucas_Interpreter
    12   \<open>(*?!?\<close> identifies a design question
    13 
    14 Distillation of "rounds of reforms":
    15   \<open>TODOs from current changesets\<close> \<rightarrow> \<open>Postponed from current changeset\<close> \<rightarrow>
    16   (*to be removed..*) \<rightarrow> \<open>Separated tasks\<close> (*.. to be removed*)
    17   \<rightarrow> subsection of \<open>Major reforms\<close>
    18 \<close>
    19 
    20 section \<open>TODOs from current changesets\<close>
    21 text\<open>
    22   Shift more complicated issues from  \<open>Current changeset\<close> to \<open>Postponed from current changeset\<close>
    23 \<close>
    24 subsection \<open>Current changeset\<close>
    25 text \<open>
    26 (*/------- to  from -------\*)
    27 (*\------- to  from -------/*)
    28   \begin{itemize}
    29   \item xxx
    30   \item push nes identifiers back from O/I_Model to Model_Def
    31   \item xxx
    32   \item rename Tactic.Calculate -> Tactic.Evaluate
    33   \item xxx
    34   \item xxx
    35   \item replace src/ Erls by Rule_Set.Empty
    36   \item xxx
    37   \item rename ptyps.sml -> specify-etc.sml
    38         rename Specify -> Specify_Etc
    39         rename SpecifyNEW -> Specify
    40   \item xxx
    41   \item specific_from_prog in..end: replace o by |> (Test_Isac or Test_Some!)
    42   \item xxx
    43   \item cleanup ThmC in MathEngBasic
    44   \item xxx
    45   \item xxx
    46   \item xxx
    47   \item xxx
    48   \item xxx
    49   \item xxx
    50   \item xxx
    51   \item xxx
    52   \end{itemize}
    53 \<close>
    54 subsection \<open>Postponed from current changeset\<close>
    55 text \<open>
    56   \begin{itemize}
    57   \item xxx
    58   \item Derive.do_one: TODO find code in common with complete_solve
    59         Derive.embed: TODO rewrite according to CAO (+ no intermediate access to Ctree)
    60   \item xxx
    61   \item Solve_Check: postponed parsing input to _ option
    62   \item xxx
    63   \item ? "fetch-tactics.sml" from Mathengine -> BridgeLibisabelle ?
    64   \item xxx
    65   \item ? unify struct.Step and struct.Solve in MathEngine ?
    66   \item xxx
    67   \item use "Eval_Def" for renaming identifiers
    68   \item xxx
    69   \item why does Test_Build_Thydata.thy depend on ProgLang and not on CalcElements ?
    70   \item xxx
    71   \item xxx
    72   \begin{itemize}
    73   \item LI.do_next (*TODO RM..*) ???
    74   \item generate.sml: RM datatype edit TOGETHER WITH datatype inout
    75   \item TermC.list2isalist: typ -> term list -> term  .. should NOT requires typ
    76   \item get_ctxt_LI should replace get_ctxt
    77   \item ALL CODE: rename spec(ification) --> know(ledge), in Specification: Relation -> Knowledge
    78   \item rename   Base_Tool.thy  <---         Base_Tools
    79   \item adopt naming conventions in Knowledge: EqSystem --> Equation_System, etc
    80   \item rename field scr in meth
    81   \item DEL double code: nxt_specify_init_calc IN specify.sml + step-specify.sml
    82   \item xxx
    83   \item xxx
    84   \item xxx
    85   \item xxx
    86   \item xxx
    87   \item xxx
    88   \item xxx
    89   \item clarify Tactic.Subproblem (domID, pblID) as term in Pstate {act_arg, ...}
    90      there it is Free ("Subproblem", "char list \<times> ..
    91      instead of  Const (|???.Subproblem", "char list \<times> ..
    92      AND THE STRING REPRESENTATION IS STRANGE: 
    93        Subproblem (''Test'',
    94         ??.\ <^const> String.char.Char ''LINEAR'' ''univariate'' ''equation''
    95          ''test'')
    96      ML \<open>
    97      \<close> ML \<open>
    98      term2str; (*defined by..*)
    99      fun term_to_string''' thy t =
   100        let
   101          val ctxt' = Config.put show_markup false (Proof_Context.init_global thy)
   102        in Print_Mode.setmp [] (Syntax.string_of_term ctxt') t end;
   103      \<close> ML \<open>
   104      val t = @{term "aaa + bbb"}
   105      val t = @{term "Subproblem (''Test'', [''LINEAR'', ''univariate'', ''equation''])"};
   106      \<close> ML \<open>
   107      val sss = Print_Mode.setmp [] (Syntax.string_of_term @{context}) t
   108      \<close> ML \<open>
   109      writeln sss (*.. here perfect: Subproblem (''Test'', [''LINEAR'', ''univariate'', ''equation'']) *)
   110      \<close> ML \<open>
   111      \<close>
   112   \item xxx
   113   \item xxx
   114   \item cleanup fun me:
   115     fun me (*(_, Empty_Tac) p _ _ = raise ERROR ("me:  Empty_Tac at " ^ pos'2str p)
   116       | me*) (_, tac) p _(*NEW remove*) pt =
   117     + -------------------------^^^^^^
   118     # see test-code.sml fun me_trace
   119       use this also for me, not only for me_ist_ctxt; del. me
   120       this requires much updating in all test/*
   121   \item xxx
   122   \item shift tests into NEW model.sml (upd, upds_envv, ..)
   123   \item xxx
   124   \item clarify handling of contexts ctxt ContextC
   125     \begin{itemize}
   126     \item xxx
   127     \item Specify/ works with thy | Interpret/ works with ctxt | MathEngine.step works with ?!?ctxt
   128     \item xxx
   129     \item Check_Elementwise "Assumptions": prerequisite for ^^goal
   130       rm tactic Check_elementwise "Assumptions" in a way, which keeps it for Minisubpbl
   131       rm Assumptions  :: bool  (* TODO: remove with making ^^^ idle *)
   132     \item xxx
   133     \item xxx
   134     \end{itemize}
   135   \item xxx
   136   \item xxx
   137   \item complete mstools.sml (* survey on handling contexts:
   138   \item xxx
   139   \item xxx
   140   \item xxx
   141   \item xxx
   142   \item librarys.ml --> libraryC.sml + text from termC.sml
   143   \item xxx
   144   \item xxx
   145   \item xxx
   146   \item xxx
   147   \item xxx
   148   \item xxx
   149   \item concentrate "insert_assumptions" for locate_input_tactic in "associate", ?OR? Tactic.insert_assumptions
   150                                    DONE  for find_next_step by Tactic.insert_assumptions m' ctxt 
   151     \begin{itemize}
   152     \item rm from "generate1" ("Detail_Set_Inst'", Tactic.Detail_Set' ?)
   153     \item ?"insert_assumptions" necessary in "init_pstate" ?+++? in "applicable_in" ?+++? "associate"
   154     \item xxx
   155     \item xxx
   156     \item DO DELETIONS AFTER analogous concentrations in find_next_step
   157     \end{itemize}
   158   \item xxx
   159   \item ? what is the difference headline <--> cascmd in
   160     Subproblem' (spec, oris, headline, fmz_, context, cascmd)
   161   \item Substitute' what does "re-calculation mean in the datatype comment?
   162   \item xxx
   163   \item inform: TermC.parse (ThyC.get_theory "Isac_Knowledge") istr --> parseNEW context istr
   164   \item xxx
   165   \item unify/clarify stac2tac_ | 
   166     \begin{itemize}
   167     \item xxx
   168     \item extract common code from associate.. stac2tac_xxx
   169     \item rename LItool.tac_from_prog -> Tactic.from_prog_tac ? Solve_Tac.from_prog_tac,
   170     \item xxx
   171     \item xxx
   172     \end{itemize}
   173   \item xxx
   174   \item unify in signature LANGUAGE_TOOLS =\\
   175     val pblterm: ThyC.id -> Problem.id -> term     vvv        vvv\\
   176     val subpbl: string -> string list -> term          unify with ^^^
   177   \item xxx
   178   \item Telem.safe is questionable: has it been replaced by Safe_Step, Not_Derivable, Helpless, etc?
   179     Note: replacement of Istate.safe by Istate.appy_ didn't care much about Telem.safe.
   180     If Telem.safe is kept, consider merge with CTbasic.ostate
   181   \item xxx
   182   \item remove find_next_step from solve Apply_Method';
   183     this enforces Pos.at_first_tactic, which should be dropped, too.
   184   \item xxx
   185   \item xxx
   186   \item xxx
   187   \end{itemize}
   188 \<close>
   189 subsection \<open>Postponed --> Major reforms\<close>
   190 text \<open>
   191   \begin{itemize}
   192   \item xxx          
   193   \item revisit bootstrap Calcelements. rule->calcelems->termC
   194     would be nice, but is hard: UnparseC.terms -> TermC.s_to_string
   195   \item xxx
   196   \item replace all Ctree.update_* with Ctree.cupdate_problem
   197   \item xxx
   198   \item rename (ist as {eval, ...}) -> (ist as {eval_rls, ...})
   199   \item xxx
   200   \item exception PROG analogous to TERM
   201   \item xxx
   202   \item sig/struc ..elems --> ..elem
   203   \item xxx          
   204   \item distille CAS-command, CAScmd, etc into a struct
   205   \item xxx          
   206   \item check location of files:
   207         test/Tools/isac/Interpret/ptyps.thy
   208         test/Tools/isac/Specify.ptyps.sml
   209   \item xxx
   210   \item check occurences of Atools in src/ test/
   211   \item Const ("Atools.pow", _) ---> Const ("Base_Tool.pow", _) 
   212   \item xxx          
   213   \item rm Float
   214   \item xxx
   215   \item Diff.thy: differentiateX --> differentiate after removal of script-constant
   216   \item Test.thy: met_test_sqrt2: deleted?!
   217   \item xxx          
   218   \item Rewrite_Ord.rew_ord' := overwritel (! Rewrite_Ord.rew_ord', (*<<<---- use Know_Store.xxx, too*)
   219   \item xxx
   220     \item automatically extrac rls from program-code 
   221       ? take ["SignalProcessing", "Z_Transform", "Inverse_sub"] as an example ?
   222   \item xxx          
   223   \item finish output of LItool.trace with Check_Postcond (useful for SubProblem)
   224   \item xxx
   225   \item replace Rule_Set.empty by Rule_Set.Empty
   226     latter is more clear, but replacing ***breaks rewriting over all examples***,
   227     e.g. see ERROR: rewrite__set_ called with 'Erls' for 'precond_rootpbl x'
   228     in Minisubplb/200-start-method-NEXT_STEP.sml:
   229      (*+* )------- in f3cac3053e7b (Rule_Set.empty just renamed, NOT deleted) we had
   230      (*+*)  prls =
   231      (*+*)    Rls {calc = [], erls = Erls, errpatts = [], id = "empty", preconds = [], rew_ord =
   232      (*+*)      ("dummy_ord", fn), rules = [], scr = Empty_Prog, srls = Erls}:
   233      (*+*).. THIS IS Rule_Set.empty, BUT IT DID not CAUSE ANY ERROR !
   234      (*+*)------- WITH Rule_Set.empty REMOVED (based on f3cac3053e7b) we had
   235      (*+*)val Empty = prls (* <---ERROR: rewrite__set_ called with 'Erls' for 'precond_rootpbl x' *)
   236      ( *+*)val ["sqroot-test", "univariate", "equation", "test"] = cpI
   237     THAT INDICATES, that much rewriting/evaluating JUST WORKED BY CHANCE?!?
   238   \item xxx          
   239   \item xxx
   240   \item xxx          
   241   \item xxx
   242   \item xxx          
   243   \item xxx
   244   \item xxx          
   245   \end{itemize}
   246 \<close>
   247 
   248 section \<open>Major reforms\<close>
   249 text \<open>
   250 \<close>
   251 subsection \<open>Exception Size raised\<close>
   252 text \<open>
   253   During update Isabelle2018 --> Isabelle2019 we noticed, that
   254   "isabelle build" uses resources more efficiently than "isabelle jedit".
   255   The former works, but the latter causes 
   256   \begin{itemize}
   257   \item "Exception- Size raised"
   258     in Build_Thydata.thy
   259   \item "exception Size raised (line 169 of "./basis/LibrarySupport.sml")"
   260     in test/../biegelinie-*.xml.
   261   \end{itemize}
   262   This has been detected after changeset (30cd47104ad7) "lucin: reorganise theories in ProgLang".
   263 
   264   Find tools to investigate the Exception, and find ways around it eventually.
   265 \<close>
   266 subsection \<open>Cleanup & review signatures wrt. implementation.pdf canonical argument order\<close>
   267 text \<open>
   268   \begin{itemize}
   269   \item there are comments in several signatures
   270   \item ML_file "~~/src/Tools/isac/Interpret/specification-elems.sml" can be (almost) deleted
   271   \item src/../Frontend/: signatures missing
   272   \item xxx
   273   \end{itemize}
   274 \<close>
   275 subsection \<open>overall structure of code\<close>
   276 text \<open>
   277   \begin{itemize}
   278   \item try to separate Isac_Knowledge from MathEngine
   279     common base: Knowledge_Author / ..??
   280   \item xxx
   281   \item  ML_file "~~/src/Tools/isac/Interpret/ctree.sml" (*shift to base in common with Interpret*)
   282   \item xxx
   283   \item xxx
   284   \item xxx
   285   \end{itemize}
   286 \<close>
   287 subsection \<open>Separate MathEngineBasic/ Specify/ Interpret/ MathEngine/\<close>
   288 text \<open>
   289   \begin{itemize}
   290   \item xxx
   291   \item xxx
   292   \item re-organise code for Interpret
   293     \begin{itemize}
   294     \item Step*: Step_Specify | Step_Solve | Step DONE
   295     \item xxx
   296     \item Prog_Tac: fun get_first_argument takes both Prog_Tac + Program --- wait for separate Tactical
   297       then shift into common descendant
   298     \item xxx
   299     \end{itemize}
   300   \item xxx
   301   \item xxx
   302   \item ??????????? WHY CAN LI.by_tactic NOT BE REPLACED BY Step_Solve.by_tactic ???????????
   303   \item xxx
   304   \item xxx
   305   \end{itemize}
   306 \<close>
   307 subsection \<open>Review modelling- + specification-phase\<close>
   308 text \<open>
   309   \begin{itemize}
   310   \item xxx
   311   \item xxx
   312   \item xxx
   313   \item check match between args of partial_function and model-pattern of meth;
   314      provide error message.
   315   \item xxx
   316   \item "--- hack for funpack: generalise handling of meths which extend problem items ---"
   317     \begin{itemize}
   318     \item see several locations of hack in code
   319     \item these locations are NOT sufficient, see
   320       test/../biegelinie-3.sml --- IntegrierenUndKonstanteBestimmen2: Bsp.7.70. auto ---
   321     \item "fun associate" "match_ags ..dI" instead "..pI" breaks many tests, however,
   322       this would be according to survey Notes (3) in src/../calchead.sml.
   323     \end{itemize}
   324   \item see "failed trial to generalise handling of meths"98298342fb6d
   325   \item abstract specify + nxt_specif to common aux-funs;
   326     see e.g. "--- hack for funpack: generalise handling of meths which extend problem items ---"
   327   \item xxx
   328   \item type model = itm list ?
   329   \item review survey Notes in src/../calchead.sml: they are questionable
   330   \item review copy-named, probably two issues commingled 
   331     \begin{itemize}
   332     \item special handling of "#Find#, because it is not a formal argument of partial_function
   333     \item special naming for solutions of equation solving: x_1, x_2, ...
   334     \end{itemize}
   335   \item xxx
   336   \item xxx
   337   \item this has been written in one go:
   338     \begin{itemize}
   339     \item reconsidering Model.max_vt, use problem with meth ["DiffApp","max_by_calculus"]
   340     \item reconsider add_field': where is it used for what? Shift into mk_oris
   341     \item reconsider match_itms_oris: where is it used for what? max_vt ONLY???
   342     \item in Specify_Method search root-oris for items (e.g. "errorBound"), #1# in survey
   343     \item Specify_Problem, Specify_Method: check respective identifiers after re-Specify_
   344       (relevant for pre-condition)
   345     \item unify match_ags to mk_oris1..N with different args (fmz | pat list, pbl | meth
   346     \item 
   347     \end{itemize}
   348   \end{itemize}
   349 \<close>
   350 subsection \<open>taci list, type step\<close>
   351 text \<open>
   352 taci was, most likely, invented to make "fun me" more efficient by avoiding duplicate rewrite,
   353 and probably, because the Kernel interface separated setNextTactic and applyTactic.
   354 Both are no good reasons to make code more complicated.
   355 
   356 !!! taci list is used in do_next !!!
   357 
   358   \begin{itemize}
   359   \item xxx
   360   \item can lev_on_total replace lev_on ? ..Test_Isac_Short + rename lev_on_total -> lev_on
   361   \item xxx
   362   \item Step* functions should return Calc.T instead of Chead.calcstate'
   363   \item xxx
   364   \item states.sml: check, when "length tacis > 1"
   365   \item in Test_Isac.thy there is only 1 error in Interpret/inform.sml
   366   \item (*WN190713 REMOVE: "creating a new node" was never implemented for more than one node?!?
   367   \item xxx
   368   \item brute force setting all empty ([], [], ptp) works!?! but ptp causes errors -- investigate!
   369   \item xxx
   370   \end{itemize}
   371 \<close>
   372 subsection \<open>Ctree\<close>
   373 text \<open>
   374 analysis
   375 # mixture pos' .. pos in cappend_*, append_* is confusing
   376 # existpt p pt andalso Tactic.is_empty DIFFERENT IN append_*, cappend_* is confusing
   377   "exception PTREE "get_obj: pos =" ^^^^^: ^^^^ due to cut !!!
   378   NOTE: exn IN if..andalso.. IS NOT!!! DETECTED, THIS                       is confusing
   379   see test/../--- Minisubpbl/800-append-on-Frm.sml ---
   380 # ?!? "cut branches below cannot be decided here" in append_atomic
   381 # sign. of functions too different ?!?canonical arg.order ?!?
   382   \begin{itemize}
   383   \item xxx
   384   \item remove update_branch, update_*? -- make branch, etc args of append_*
   385   \item xxx
   386   \item close sig Ctree, contains cappend_* ?only? --- ?make parallel to ?Pide_Store?
   387   \item xxx
   388   \item unify args to Ctree.state (pt, p)
   389   \item  fun update_env       .. repl_env                   \<rightarrow>updatempty
   390   \item xxx
   391   \item xxx
   392   \item xxx
   393   \item xxx
   394   \end{itemize}
   395 \<close>
   396 subsection \<open>replace theory/thy by context/ctxt\<close>
   397 text \<open>
   398   \begin{itemize}
   399   \item xxx
   400   \item Specify/ works with thy | Interpret/ works with ctxt | MathEngine.step works with ?!?ctxt
   401     special case: Tactic.Refine_Problem
   402   \item xxx
   403   \item theory can be retrieved from ctxt by Proof_Context.theory_of
   404   \item xxx
   405   \item cleaup the many conversions string -- theory
   406   \item make dest_spec --> (theory, pblID, metID) ?+ common_subthy ?
   407   \item 1. Rewrite.eval_true_, then
   408     LItool.check_leaf, Rewrite.eval_prog_expr, Step.add, LItool.tac_from_prog.
   409   \item fun associate
   410     let val thy = ThyC.get_theory "Isac_Knowledge";(*TODO*)
   411   \item xxx
   412   \item xxx
   413   \item in locate_input_tactic .. ?scan_dn1?; Program.is_eval_expr   .use  Term.exists_Const
   414   \item push srls into pstate
   415   \item lucas-intrpreter.locate_input_tactic: scan_to_tactic1 srls tac cstate (progr, Rule_Set.Empty)
   416                                                                                       ^^^^^^^^^^^^^^^
   417   \item xxx
   418   \end{itemize}
   419 \<close>
   420 subsection \<open>Rfuns, Begin_/End_Detail', Rrls, Istate\<close>
   421 text \<open>
   422 remove refactor Rfuns, Rule.Prog, Rule.Empty_Prog, RrlsState: this is a concept never brought to work.
   423   Clarify relation to reverse rewriting!
   424   \begin{itemize}
   425   \item separate mut.recursion program with rule and rls by deleting fild scr in rls
   426     (possible since CS 43160c1e775a
   427   ` "replace Prog. in prep_rls by Auto_Prog.gen, which generates Prog. on the fly" )
   428   \item xxx
   429   \item probably only "normal_form" seems to be needed
   430   \item deleted Rfuns in NEW "locate_input_tactic": no active test for "locate_rule"
   431     but that seems desirable
   432   \item ?how is the relation to reverse-rewriting ???
   433   \item "Rfuns" markers in test/../rational
   434   \item xxx
   435   \item datatype istate (Istate.T): remove RrlsState, pstate: use Rrls only for creating results beyond
   436     rewriting and/or respective intermediate steps (e.g. cancellation of fractions).
   437     Thus we get a 1-step-action which does NOT require a state beyond istate/pstate.
   438     Thus we drastically reduce complexity, also get rid of "fun from_pblobj_or_detail_calc" , etc.
   439   \item debug ^^^ related: is there an occurence of Steps with more than 1 element?
   440   \item xxx
   441   \item and do_next (* WN1907: ?only for Begin_/End_Detail' DEL!!!*)
   442   \item xxx
   443   \item shouldn't go Rfuns from Rewrite --> Rewrite_Set; they behave similar to "fun interSteps" ?
   444   \item xxx
   445   \item ?finally Prog could go from Calcelems to ProgLang?
   446   \end{itemize}
   447 \<close>
   448 subsection \<open>Inverse_Z_Transform.thy\<close>
   449 text \<open>
   450   \begin{itemize}
   451   \item\label{new-var-rhs} rule1..6, ruleZY introduce new variables on the rhs of the rewrite-rule.
   452   ? replace rewriting with substitution ?!?
   453   The problem is related to the decision of typing for "d_d" and making bound variables free (while
   454   shifting specific handling in equation solving etc. to the meta-logic). 
   455   \item Find "stepResponse (x[n::real]::bool)" is superfluous, because immediately used by
   456     rewrite-rules; see \ref{new-var-rhs}.
   457   \item Reconsider whole problem:
   458     input only the polynomial as argument of partial_function, in ([1], Frm) compile lhs "X z" ?
   459   \end{itemize}
   460 \<close>
   461 subsection \<open>Adopt Isabelle's numerals for Isac\<close>
   462 text \<open>
   463   \begin{itemize}
   464   \item replace numerals of type "real" by "nat" in some specific functions from ListC.thy
   465     and have both representations in parallel for "nat".
   466   \item xxx
   467   \item xxx
   468   \end{itemize}
   469 \<close>
   470 subsection \<open>Redesign equation solver\<close>
   471 text \<open>
   472   Existing solver is structured along the WRONG assumption,
   473   that Poly.thy must be the LAST thy among all thys involved -- while the opposite is the case.
   474 
   475   Preliminary solution: all inappropriately located thms are collected in Base_Tools.thy
   476 \<close>
   477 subsection \<open>Finetunig required for xmldata in kbase\<close>
   478 text \<open>
   479   See xmldata https://intra.ist.tugraz.at/hg/isac/rev/5b222a649390
   480   and in kbase html-representation generated from these xmldata.
   481   Notes in ~~/xmldata/TODO.txt.
   482 \<close>
   483 
   484 section \<open>Hints for further development\<close>
   485 text \<open>
   486 \<close>
   487 subsection \<open>Coding standards & some explanations for math-authors\<close>
   488 text \<open>copy from doc/math-eng.tex WN.28.3.03
   489 WN071228 extended\<close>
   490 
   491 subsubsection \<open>Identifiers\<close>
   492 text \<open>Naming is particularily crucial, because Isabelles name space is global, and isac does
   493   not yet use the novel locale features introduces by Isar. For instance, {\tt probe} sounds
   494   reasonable as (1) a description in the model of a problem-pattern, (2) as an element of the
   495   problem hierarchies key, (3) as a socalled CAS-command, (4) as the name of a related script etc.
   496   However, all the cases (1)..(4) require different typing for one and the same
   497   identifier {\tt probe} which is impossible, and actually leads to strange errors
   498   (for instance (1) is used as string, except in a script addressing a Subproblem).
   499 
   500   These are the preliminary rules for naming identifiers>
   501   \begin{description}
   502   \item [elements of a key] into the hierarchy of problems or methods must not contain
   503     capital letters and may contain underscrores, e.g. {\tt probe, for_polynomials}.
   504   \item [descriptions in problem-patterns] must contain at least 1 capital letter and
   505     must not contain underscores, e.g. {\tt Probe, forPolynomials}.
   506   \item [CAS-commands] follow the same rules as descriptions in problem-patterns above, thus
   507     beware of conflicts~!
   508   \item [script identifiers] always end with {\tt Program}, e.g. {\tt ProbeScript}.
   509   \item [???] ???
   510   \item [???] ???
   511   \end{description}
   512 %WN071228 extended\<close>
   513 
   514 subsubsection \<open>Rule sets\<close>
   515 text \<open>The actual version of the coding standards for rulesets is in {\tt /IsacKnowledge/Atools.ML
   516   where it can be viewed using the knowledge browsers.
   517 
   518   There are rulesets visible to the student, and there are rulesets visible (in general) only for
   519   math authors. There are also rulesets which {\em must} exist for {\em each} theory;
   520   these contain the identifier of the respective theory (including all capital letters) 
   521   as indicated by {\it Thy} below.
   522 
   523   \begin{description}
   524   \item [norm\_{\it Thy}] exists for each theory, and {\em efficiently} calculates a
   525     normalform for all terms which can be expressed by the definitions of the respective theory
   526     (and the respective parents).
   527   \item [simplify\_{\it Thy}] exists for each theory, and calculates a normalform for all terms
   528     which can be expressed by the definitions of the respective theory (and the respective parents)
   529     such, that the rewrites can be presented to the student.
   530   \item [calculate\_{\it Thy}] exists for each theory, and evaluates terms with 
   531     numerical constants only (i.e. all terms which can be expressed by the definitions of
   532     the respective theory and the respective parent theories). In particular, this ruleset includes
   533     evaluating in/equalities with numerical constants only.
   534     WN.3.7.03: may be dropped due to more generality: numericals and non-numericals
   535     are logically equivalent, where the latter often add to the assumptions
   536     (e.g. in Check_elementwise).
   537   \end{description}
   538 
   539   The above rulesets are all visible to the user, and also may be input; 
   540   thus they must be contained in {\tt Theory_Data} (KEStore_Elems.add_rlss,
   541   KEStore_Elems.get_rlss). All these rulesets must undergo a preparation
   542   using the function {\tt prep_rls'}, which generates a script for stepwise rewriting etc.
   543   The following rulesets are used for internal purposes and usually invisible to the (naive) user:
   544 
   545   \begin{description}
   546   \item [*\_erls] TODO
   547   \item [*\_prls] 
   548   \item [*\_srls] 
   549   \end{description}
   550 {\tt Rule_Set.append_rules, Rule_Set.merge, remove_rls} TODO
   551 \<close>
   552 
   553 subsection \<open>get proof-state\<close>
   554 text \<open>
   555   Re: [isabelle] Programatically get "this"
   556   ----------------------------------------------------
   557   So here is my (Makarius') version of your initial example, following these principles:
   558   begin{verbatim}
   559     notepad
   560     begin
   561       assume a: A
   562       ML_val \<open>
   563         val ctxt = @{context};
   564     
   565         val this_name =
   566           Name_Space.full_name (Proof_Context.naming_of ctxt) (Binding.name Auto_Bind.thisN);
   567         val this = #thms (the (Proof_Context.lookup_fact ctxt this_name));
   568       \<close>
   569     end
   570   end{verbatim}
   571 \<close>
   572 subsection \<open>write Specification to jEdit\<close>
   573 text \<open>
   574   Re: [isabelle] Printing terms with type annotations
   575   ----------------------------------------------------
   576   On 06/02/2019 17:52, Moa Johansson wrote:
   577   >
   578   > I’m writing some code that should create a snippet of Isar script.
   579   
   580   This is how Sledgehammer approximates this:
   581   
   582   http://isabelle.in.tum.de/repos/isabelle/file/Isabelle2018/src/HOL/Tools/Sledgehammer/sledgehammer_isar_proof.ML#l299
   583   
   584   (The module name already shows that the proper terminology is "Isar
   585   proof" (or "Isar proof text").  Proof scripts are a thing from the past,
   586   before Isar. You can emulate old-style proof scripts via a sequence of
   587   'apply' commands, but this is improper Isar.)
   588   
   589   Note that there is no standard function in Isabelle/Pure, because the
   590   problem to print just the right amount of type information is very
   591   complex and not fully solved. One day, after 1 or 2 rounds of
   592   refinements over the above approach, it might become generally available.
   593 \<close>
   594 subsection \<open>follow Isabelle conventions (*Does not yet work in Isabelle2018\<close>
   595 text \<open>
   596   isabelle update -u path_cartouches
   597   isabelle update -u inner_syntax_cartouches
   598 \<close>
   599 section \<open>Questions to Isabelle experts\<close>
   600 text \<open>
   601 \begin{itemize}
   602 \item ad ERROR Undefined fact "all_left"        in Test_Isac: error-pattern.sml
   603                Undefined fact: "xfoldr_Nil"                   inssort.sml
   604     (* probably two different reasons:
   605     src/../LinEq.thy
   606       (*WN0509 compare PolyEq.all_left "[|Not(b=!=0)|] ==> (a = b) = (a - b = 0)"*)
   607       all_left:          "[|Not(b=!=0)|] ==> (a=b) = (a+(-1)*b=0)" and
   608     
   609     src/../PolyEq.thy
   610       (*WN0509 compare LinEq.all_left "[|Not(b=!=0)|] ==> (a=b) = (a+(-1)*b=0)"*)
   611       all_left:              "[|Not(b=!=0)|] ==> (a = b) = (a - b = 0)" and
   612     
   613     test/../partial_fractions.sml
   614     (*[7], Met*)val (p,_,f,nxt,_,pt) = me nxt p [] pt; (*nxt = Apply_Method ["PolyEq", "normalise_poly"])*)
   615     (*[7, 1], Frm*)val (p,_,f,nxt,_,pt) = me nxt p [] pt; (*nxt = Rewrite ("all_left", "\<not> ?b =!= 0 \<Longrightarrow> (?a = ?b) = (?a - ?b = 0)"))*)
   616     
   617     test/../mathengine-stateless.sml
   618     (*if ThmC.string_of_thm @ {thm rnorm_equation_add} =  "\<not> ?b =!= 0 \<Longrightarrow> (?a = ?b) = (?a + - 1 * ?b = 0)"
   619     then () else error "string_of_thm changed";*)
   620     
   621     (*---------------------------------------------------------------------------------------------*)
   622     src/../LinEq.thy
   623     primrec xfoldr :: "('a \<Rightarrow> 'b \<Rightarrow> 'b) \<Rightarrow> 'a xlist \<Rightarrow> 'b \<Rightarrow> 'b" where
   624     xfoldr_Nil:  "xfoldr f {|| ||} = id" |
   625     xfoldr_Cons: "xfoldr f (x @# xs) = f x \<circ> xfoldr f xs"
   626     
   627     src/../InsSort.thy
   628         srls = Rule_Set.empty, calc = [], rules = [
   629           Rule.Thm ("xfoldr_Nil",(*num_str*) @{thm xfoldr_Nil} (* foldr ?f [] = id *)),
   630     *)
   631 \item xxx
   632 \item xxx
   633 \item ?OK Test_Isac_Short with
   634     LI.by_tactic tac (get_istate_LI pt p, get_ctxt_LI pt p) ptp
   635   instead
   636     LI.by_tactic tac (Istate.empty, ContextC.empty) ptp
   637   in step-solve ?
   638 \item xxx
   639 \item test from last CS with outcommented re-def of code -> 
   640   -> \<open>further tests additional to src/.. files\<close>
   641       ADDTESTS/redefined-code.sml
   642 \item xxx
   643 \item efb749b79361 Test_Some_Short.thy has 2 errors, which disappear in thy ?!?:
   644   ML_file "Interpret/error-pattern.sml" Undefined fact: "all_left"
   645   ML_file "Knowledge/inssort.sml" Undefined fact: "xfoldr_Nil"
   646 \item xxx
   647 \item what is the actual replacement of "hg log --follow" ?
   648 \item xxx
   649 \item how HANDLE these exceptions, e.g.:
   650     Syntax.read_term ctxt "Randbedingungen y 0 = (0::real), y L = 0, M_b 0 = 0, M_b L = 0]"
   651   GIVES
   652     "Inner syntax error
   653      Failed to parse term"
   654 \item xxx
   655 \item how cope with "exception Size raised (line 171 of "./basis/LibrarySupport.sml")"
   656   e.g. in test/Interpret/lucas-interpreter.sml
   657 \item xxx
   658 \item xxx
   659 \end{itemize}
   660 \<close>
   661 
   662 section \<open>For copy & paste\<close>
   663 text \<open>
   664 \begin{itemize}
   665 \item xxx
   666   \begin{itemize}
   667   \item xxx
   668     \begin{itemize}
   669     \item xxx
   670       \begin{itemize}
   671       \item xxx
   672         \begin{itemize}
   673         \item xxx
   674         \end{itemize}
   675       \end{itemize}
   676     \end{itemize}
   677   \end{itemize}
   678 \end{itemize}
   679 \<close>
   680 subsection \<open>xxx\<close>
   681 subsubsection \<open>xxx\<close>
   682 end