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