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