lshifr / codeformatter Goto Github PK

I'd like to use CodeFormatterPrint to serialize definitions and a canonical but readable way. For this, all the code it produces should, when evaluated, restore the definitions I had in place.

But this does not always work:

ClearAll@f
f[veryveryveryveryveryveryveryverylongname, 
    veryveryveryveryveryveryveryverylongname] /; a > 0 := a;
CodeFormatterPrint@f

produces

f[    
     veryveryveryveryveryveryveryverylongname,
     veryveryveryveryveryveryveryverylongname
 ]
/;
  (a > 0) :=
     a

which cannot be parsed correctly because /; stands on its own.

/; should be at the end of the line above such that the expression is not yet complete.

a^b or Power[a, b] throws $Failed. Maybe typesetting boxes (like SuperscriptBox here and FractionBox in scdevries's example) should all be avoided?

f@x and x//f are replaced with f[x], which although equivalent may not what one wants to see

Formatting of fractions in the code can become rather weird:

Join[Total[
Join[1/2 Differences[
VeryLongFunctionNameVeryLongFunctionNameVeryLongFunctionName],
Most[defaults]]]/
Total[Join[1/2 Differences[optimal], Most[optimal]]], a]

http://mathematica.stackexchange.com/questions/2809/programmatic-formatting-for-mathematica-code-possible/2810#2810

CodeFormatterPrint should IMO be named something like PrettyPrintSymbolDefintions.

I don't think the names should include CodeFormatter as they are already in that package. Maybe have prefixes to avoid conflicts.

FullCodeFormat and consorts should IMO also accept non-box form expressions and do the conversion themselves.

Full documentation (with F1-ability) would also be nice once this matures some more.

https://github.com/lshifr/CodeFormatter/blob/master/README.md#installation

I noticed that: FileNameJoin[$UserBaseDirectory, "Applications"] is missing { } which causes errors. Replace with: FileNameJoin[{$UserBaseDirectory, "Applications"}]

Mathematica allows the use of colorsetters as part of the code (so that the programmer can conveniently choose a new color right in the middle of the source by just clicking). A line of code may read like this:

edgeColor = !(*
TagBox[
ColorSetterBox[RGBColor[1., 0., 0.], "Swatch"],
Setting]);

One enters this by DynamicSetting[ColorSetter[]] and executing-in-place (ctrl-shift-enter). Prettifying a line like this yields:

During evaluation of In[164]:= Throw::nocatch: Uncaught Throw[{$Failed,ColorSetterBox[RGBColor[1.,0.,0.],Swatch]},CodeFormatterPrivatepreformat] returned to top level. >>

Out[164]= Hold[
Throw[{$Failed, ColorSetterBox[RGBColor[1., 0., 0.], "Swatch"]},
CodeFormatterPrivatepreformat]]

[I know this is perverse coding]

This may or may not be considered an issue: bitmaps used as part of the source code (which mathematica happily allows and advocates) are replaced with elaborate Image functions.

From the code it seems as if CodeFormatterPrint uses FullCodeFormat, but on a given definition their output still differs:

ClearAll[f]
f[x : _a | _b] := 0;
CodeFormatterPrint@f

f[x : (Blank[a] | Blank[b])] :=
     0

is not as nice as

boxes = MakeBoxes[f[x : _a | _b] := 0];
prn = CellPrint[Cell[BoxData[#], "Input"]] &;
prn@FullCodeFormat@boxes

f[x : _a | _b] :=
     0