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