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