manual, code example preprocessor : full conversion to compiler-libs (#…

…1863)

* manual tools: use toploop directly in caml_tex2
* manual tool: improved error messages
* manual: always print errors and warnings
* fix nefarious interaction with GPR#1120
* move manual/tools/caml_tex2 to tools/caml_tex
* Basic text for caml-tex

.gitignore

@@ -245,6 +245,7 @@ _ocamltestd
 /tools/stripdebug.opt
 /tools/make_opcodes
 /tools/make_opcodes.ml
+/tools/caml-tex
 
 /utils/config.ml
 

Changes

@@ -152,6 +152,9 @@ Working version
 - GPR#1831: move the local exceptions and exception cases to the main chapters.
   (Florian Angeletti, review by Perry E. Metzger and Jeremy Yallop)
 
+- GPR#1863: caml-tex2, move to compiler-libs
+  (Florian Angeletti, review by Sébastien Hinderer and Gabriel Scherer)
+
 ### Compiler distribution build system:
 
 - GPR#1776: add -no-install-bytecode-programs and related configure options to

manual/README.md

@@ -117,7 +117,7 @@ Latex extensions
 
 ### Caml environments
 
-The tool `tools/caml-tex2` is used to generate the latex code for the examples
+The tool `tools/caml-tex` is used to generate the latex code for the examples
 in the introduction and language extension parts of the manual. It implements
 two pseudo-environments: `caml_example` and `caml_eval`.
 
@@ -145,10 +145,10 @@ otherwise an error would be raised.
 The `verbatim` does not require a final `;;` and is intended to be
 a lighter mode for code examples.
 
-By default, `caml_tex2` raises an error and stops if the output of one
+By default, `caml-tex` raises an error and stops if the output of one
 the `caml_example` environment contains an unexpected error or warning.
 If such an error or warning is, in fact, expected, it is necessary to
-indicate the expected output status to `caml_tex2` by adding either
+indicate the expected output status to `caml-tex` by adding either
 an option to the `caml_example` environment:
 ```latex
 \begin{caml_example}{toplevel}[error]

manual/manual/cmds/Makefile

@@ -5,12 +5,11 @@ LD_PATH = "$(TOPDIR)/otherlibs/str:$(TOPDIR)/otherlibs/unix"
 
 TOOLS = ../../tools
 CAMLLATEX = $(SET_LD_PATH) \
-  $(OCAMLRUN) $(TOOLS)/caml-tex2 \
-  -caml "TERM=norepeat $(OCAML)" -n 80 -v false
+  $(OCAMLRUN) $(TOPDIR)/tools/caml-tex \
+  -repo-root $(TOPDIR) -n 80 -v false
 TEXQUOTE = $(OCAMLRUN) $(TOOLS)/texquote2
 TRANSF = $(SET_LD_PATH) $(OCAMLRUN) $(TOOLS)/transf
 
-
 FILES = comp.tex top.tex runtime.tex native.tex lexyacc.tex intf-c.tex \
   depend.tex profil.tex debugger.tex browser.tex ocamldoc.tex \
   warnings-help.tex ocamlbuild.tex flambda.tex spacetime.tex \

manual/manual/refman/Makefile

@@ -5,8 +5,8 @@ LD_PATH = "$(TOPDIR)/otherlibs/str:$(TOPDIR)/otherlibs/unix"
 
 TOOLS = ../../tools
 CAMLLATEX = $(SET_LD_PATH) \
-  $(OCAMLRUN) $(TOOLS)/caml-tex2 \
-  -caml "TERM=norepeat $(OCAML)" -n 80 -v false
+  $(OCAMLRUN) $(TOPDIR)/tools/caml-tex \
+  -repo-root $(TOPDIR) -n 80 -v false
 TEXQUOTE = $(OCAMLRUN) $(TOOLS)/texquote2
 TRANSF = $(SET_LD_PATH) $(OCAMLRUN) $(TOOLS)/transf
 

manual/manual/tutorials/Makefile

@@ -5,8 +5,8 @@ LD_PATH = "$(TOPDIR)/otherlibs/str:$(TOPDIR)/otherlibs/unix"
 
 TOOLS = ../../tools
 CAMLLATEX = $(SET_LD_PATH) \
-  $(OCAMLRUN) $(TOOLS)/caml-tex2 \
-  -caml "TERM=norepeat $(OCAML)" -n 80 -v false
+  $(OCAMLRUN) $(TOPDIR)/tools/caml-tex \
+  -repo-root $(TOPDIR) -n 80 -v false
 TEXQUOTE = $(OCAMLRUN) $(TOOLS)/texquote2
 TRANSF = $(SET_LD_PATH) $(OCAMLRUN) $(TOOLS)/transf
 

manual/manual/tutorials/objectexamples.etex

@@ -699,7 +699,7 @@ The following idiom separates description and definition.
 \begin{caml_example*}{toplevel}
 class type ['a] iterator =
   object method fold : ('b -> 'a -> 'b) -> 'b -> 'b end;;
-class intlist l =
+class intlist' l =
   object (self : int #iterator)
     method empty = (l = [])
     method fold f accu = List.fold_left f accu l

manual/tools/.gitignore

@@ -6,7 +6,6 @@ htmlgen
 htmlquote
 latexscan.ml
 dvi2txt
-caml-tex2
 *.dSYM
 *.cm[io]
 *.o

manual/tools/Makefile

@@ -2,23 +2,17 @@ TOPDIR=../..
 COMPFLAGS=-I $(OTOPDIR)/otherlibs/str -I $(OTOPDIR)/otherlibs/unix
 include $(TOPDIR)/Makefile.tools
 
-all: texquote2 transf caml-tex2
+all: texquote2 transf
 
 
 transf: transf.cmo htmltransf.cmo transfmain.cmo
 	$(OCAMLC) -o $@ -g $^
 
 transfmain.cmo: transf.cmo htmltransf.cmo
 
-
-caml-tex2: caml_tex2.ml
-	$(OCAMLC) $(TOPDIR)/compilerlibs/ocamlcommon.cma -I $(TOPDIR)/parsing \
-	  -o $@ str.cma unix.cma $<
-
 texquote2: texquote2.ml
 	$(OCAMLC) -o $@ $<
 
-
 %.cmo: %.ml
 	$(OCAMLC) -c $<
 
@@ -33,4 +27,4 @@ texquote2: texquote2.ml
 clean:
 	rm -f *.o *.cm? *.cmx?
 	rm -f transf.ml htmltransf.ml
-	rm -f texquote2 transf caml-tex2
+	rm -f texquote2 transf

testsuite/tests/tool-caml-tex/ocamltests

@@ -0,0 +1 @@
+redirections.ml

testsuite/tests/tool-caml-tex/redirections.ml

@@ -0,0 +1,19 @@
+(* TEST
+   reference="${test_source_directory}/redirections.reference"
+   output="redirections.output"
+   script = "${ocamlrun} ${ocamlsrcdir}/tools/caml-tex \
+   -repo-root ${ocamlsrcdir} ${test_source_directory}/${test_file} -o ${output}"
+  * script with unix,str
+  ** check-program-output
+*)
+
+\begin{caml_example}{toplevel}
+[@@@warning "+A"];;
+1 + 2. [@@expect error];;
+let f x = () [@@expect warning 27];;
+\end{caml_example}
+
+\begin{caml_example}{toplevel}
+Format.printf "Hello@.";
+print_endline "world";;
+\end{caml_example}

testsuite/tests/tool-caml-tex/redirections.reference

@@ -0,0 +1,30 @@
+(* TEST
+   reference="${test_source_directory}/redirections.reference"
+   output="redirections.output"
+   script = "${ocamlrun} ${ocamlsrcdir}/tools/caml-tex \
+   -repo-root ${ocamlsrcdir} ${test_source_directory}/${test_file} -o ${output}"
+  * script with unix,str
+  ** check-program-output
+*)
+
+\camlexample{toplevel}
+\caml\camlinput\?[@@@warning "+A"];;
+\endcamlinput\endcaml
+\caml\camlinput\?1 + \<2.\> ;;
+\endcamlinput\camlerror\:Error: This expression has type float but an expression was expected of type
+\:         int
+\endcamlerror\endcaml
+\caml\camlinput\?let f \<x\> = () ;;
+\endcamlinput\camlwarn\:Warning 27: unused variable x.
+\:val f : \textquotesingle\-a -> unit = <fun>
+\endcamlwarn\endcaml
+\endcamlexample
+
+\camlexample{toplevel}
+\caml\camlinput\?Format.printf "Hello@.";
+\?print_endline "world";;
+\endcamlinput\camloutput\:Hello
+\:world
+\:- : unit = ()
+\endcamloutput\endcaml
+\endcamlexample

tools/Makefile

@@ -398,6 +398,26 @@ install::
 	  "$(INSTALL_BINDIR)/"
 endif
 
+CAMLTEX= ../compilerlibs/ocamlcommon.cma \
+	../compilerlibs/ocamlbytecomp.cma \
+	../compilerlibs/ocamltoplevel.cma \
+	../otherlibs/str/str.cma \
+	../otherlibs/$(UNIXLIB)/unix.cma \
+	caml_tex.ml
+
+#Scan latex files, and run ocaml code examples
+
+caml-tex: INCLUDES+= -I ../otherlibs/str -I ../otherlibs/$(UNIXLIB)
+caml-tex: $(CAMLTEX)
+	../runtime/ocamlrun ../ocamlc -nostdlib -I ../stdlib $(LINKFLAGS) \
+	-linkall -o $@ $(CAMLTEX)
+
+# we need str and unix which depend on the bytecode version of other tools
+# thus we delay building caml-tex to the opt.opt stage
+opt.opt:caml-tex
+clean::
+	rm -f -- caml-tex caml_tex.cm?
+
 # Common stuff
 
 .SUFFIXES: