-- set/get tester

-- Copyright (C) 2008 Jerry Bauck

-- This file is part of PLplot.

-- PLplot is free software; you can redistribute it and/or modify
-- it under the terms of the GNU Library General Public License as published
-- by the Free Software Foundation; either version 2 of the License, or
-- (at your option) any later version.

-- PLplot is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-- GNU Library General Public License for more details.

-- You should have received a copy of the GNU Library General Public License
-- along with PLplot; if not, write to the Free Software
-- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

with
    Ada.Text_IO,
    Ada.Long_Float_Text_IO,
    Ada.Strings,
    Ada.Strings.Fixed,
    Ada.Strings.Unbounded,
    Ada.Numerics,
    Ada.Numerics.Long_Elementary_Functions,
    PLplot_Auxiliary,
    PLplot_Standard;
use
    Ada.Text_IO,
    Ada.Long_Float_Text_IO,
    Ada.Strings,
    Ada.Strings.Fixed,
    Ada.Strings.Unbounded,
    Ada.Numerics,
    Ada.Numerics.Long_Elementary_Functions,
    PLplot_Auxiliary,
    PLplot_Standard;

-- This example mostly outputs text. As part of the PLplot testing regime, we
-- require that the text output match that of the C version, x31c.c, exactly.
-- Therefore, certain extra measures were made in this Ada version to assure
-- that matching text is created.

procedure xstandard31a is
    xmin0, xmax0, ymin0, ymax0, zxmin0, zxmax0, zymin0, zymax0 : Long_Float;
    xmin, xmax, ymin, ymax, zxmin, zxmax, zymin, zymax : Long_Float;
    xmid, ymid, wx, wy : Long_Float;
    mar0, aspect0, jx0, jy0, ori0 : Long_Float;
    mar, aspect, jx, jy, ori : Long_Float;
    win, level2, digmax, digit, compression1, compression2 : Integer;
    xp0, yp0, xp1, yp1, xp2, yp2 : Long_Float;
    xleng0, yleng0, xoff0, yoff0 : Integer;
    xleng1, yleng1, xoff1, yoff1, xleng2, yleng2, xoff2, yoff2 : Integer;
    num0, bmax0, num1, bmax1, num2, bmax2, r0, g0, b0, r, g, b : Integer;
    fam0, fam1, fam2 : Boolean;
    a0, a : Long_Float;
    r1 : Integer_0_255_Array(0 .. 1) := (0, 255);
    g1 : Integer_0_255_Array(0 .. 1) := (0, 255);
    b1 : Integer_0_255_Array(0 .. 1) := (0,   0);
    a1 : Real_Vector(0 .. 1) := (1.0, 1.0);
    status : Integer;
    fnam : Unbounded_String;

    -- Convert a boolean to integers 0 or 1.
    function Boolean_To_Integer(B : Boolean) return Integer is
    begin
        if B then
            return 1;
        else
            return 0;
        end if;
    end Boolean_To_Integer;

    -- Function to return a formated float that looks like what C does.
    function PF(x : Long_Float) return String is
        A_String : String(1 .. 30);
    begin
        Put(A_String, x, Aft => 6, Exp => 0);
        return Trim(A_String, Left);
    end PF;

begin
    -- Parse and process command line arguments
    status := 0;

    Parse_Command_Line_Arguments(Parse_Full);

    -- Test setting / getting familying parameters before plinit.
    -- Save values set by plparseopts to be restored later.
    Get_File_Family_Parameters(fam0, num0, bmax0);
    fam1 := False;
    num1 := 10;
    bmax1 := 1000;
    Set_File_Family_Parameters(fam1, num1, bmax1);

    -- Retrieve the same values?
    Get_File_Family_Parameters(fam2, num2, bmax2);
    Put_Line("family parameters: fam, num, bmax ="
        & Integer'image(Boolean_To_Integer(fam2))
        & Integer'image(num2) & Integer'image(bmax2));
    if fam2 /= fam1 or num2 /= num1 or bmax2 /= bmax1 then
        Put_Line(Standard_Error, "Get_File_Family_Parameters test failed");
        status := 1;
    end if;
    -- Restore values set initially by plparseopts.
    Set_File_Family_Parameters(fam0, num0, bmax0);

    -- Test setting / getting page parameters before plinit.
    -- Save values set by plparseopts to be restored later.
    Get_Page_Parameters(xp0, yp0, xleng0, yleng0, xoff0, yoff0);
    xp1 := 200.0;
    yp1 := 200.0;
    xleng1 := 400;
    yleng1 := 200;
    xoff1 := 10;
    yoff1 := 20;
    Set_Page_Parameters(xp1, yp1, xleng1, yleng1, xoff1, yoff1);

    -- Retrieve the same values?
    Get_Page_Parameters(xp2, yp2, xleng2, yleng2, xoff2, yoff2);
    Put("page parameters: xp, yp, xleng, yleng, xoff, yoff = "
        & PF(xp2) & " " & PF(yp2));
    Put_Line(Integer'image(xleng2) & Integer'image(yleng2)
        & Integer'image(xoff2) & Integer'image(yoff2));
    if xp2 /= xp1 or yp2 /= yp1 or xleng2 /= xleng1 or yleng2 /= yleng1 or
      xoff2 /= xoff1 or yoff2 /= yoff1 then
        Put_Line(Standard_Error, "Get_Page_Parameters test failed");
        status := 1;
    end if;
    -- Restore values set initially by plparseopts.
    Set_Page_Parameters(xp0, yp0, xleng0, yleng0, xoff0, yoff0);

    -- Test setting / getting compression parameter across Initialize_PLplot.
    compression1 := 95;
    Set_Compression_Level(compression1);

    -- Initialize plplot.
    Initialize_PLplot;

    -- Test if device initialization screwed around with the preset
    -- compression parameter.
    Get_Compression_Level(compression2);
    Put_Line("Output various PLplot parameters");
    Put_Line("compression parameter =" & Integer'image(compression2));
    if (compression2 /= compression1) then
        Put_Line(Standard_Error, "Get_Compression_Level test failed");
        status := 1;
    end if;

    -- Exercise Enable_Color_Output, Set_One_Color_Map_0, Set_Color_Map_1_RGB, and Set_Color_Map_1_RGBa to make sure
    -- they work without any obvious error messages.
    Enable_Color_Output(True);
    Set_One_Color_Map_0(1, 255, 0, 0);
    Set_Color_Map_1_RGB(r1, g1, b1);
    Set_Color_Map_1_RGB_And_Alpha(r1, g1, b1, a1);

    Get_Run_Level(level2);
    Put_Line("level parameter =" & Integer'image(level2));
    if (level2 /= 1) then
        Put_Line(Standard_Error, "Get_Run_Level test failed.");
        status := 1;
    end if;

    Advance_To_Subpage(Next_Subpage);

    xmin0 := 0.01;
    xmax0 := 0.99;
    ymin0 := 0.02;
    ymax0 := 0.49;
    Set_Viewport_Normalized(xmin0, xmax0, ymin0, ymax0);
    Get_Viewport_Normalized(xmin, xmax, ymin, ymax);
    Put_Line("plvpor: xmin, xmax, ymin, ymax = "
        & PF(xmin) & " " & PF(xmax) & " " & PF(ymin) & " " & PF(ymax));
    if xmin /= xmin0 or xmax /= xmax0 or ymin /= ymin0 or ymax /= ymax0 then
        Put_Line(Standard_Error, "Get_Viewport_Normalized test failed");
        status := 1;
    end if;
    xmid := 0.5 * (xmin + xmax);
    ymid := 0.5 * (ymin + ymax);

    xmin0 := 0.2;
    xmax0 := 0.3;
    ymin0 := 0.4;
    ymax0 := 0.5;
    Set_Viewport_World(xmin0, xmax0, ymin0, ymax0);
    Get_Viewport_World(xmin, xmax, ymin, ymax);
    Put_Line("plwind: xmin, xmax, ymin, ymax = "
        & PF(xmin) & " " & PF(xmax) & " " & PF(ymin) & " " & PF(ymax));
    if xmin /= 0.2 or xmax /= 0.3 or ymin /= 0.4 or ymax /= 0.5 then
        Put_Line(Standard_Error, "Get_Viewport_World test failed");
        status := 1;
    end if;

    -- Get world coordinates for middle of viewport.
    World_From_Relative_Coordinates(xmid,ymid,wx,wy,win);
    Put_Line("world parameters: wx, wy, win = "
        & PF(wx) & " " & PF(wy) & Integer'image(win));
    if abs(wx-0.5*(xmin+xmax))>1.0E-5 or abs(wy-0.5*(ymin+ymax))>1.0E-5 then
        Put_Line(Standard_Error, "World_From_Relative_Coordinates test failed");
        status := 1;
    end if;

    -- Retrieve and print the name of the output file (if any).
    -- This goes to stderr not stdout since it will vary between tests and
    -- we want stdout to be identical for compare test.
    fnam := To_Unbounded_String(Get_Output_File_Name);
    if fnam = Null_Unbounded_String then
        Put_Line("No output file name is set");
    else
        Put_Line("Output file name read");
    end if;
    Put_Line(Standard_Error, "Output file name is " & Get_Output_File_Name);

    -- Set and get the number of digits used to display axis labels.
    -- Note digit is currently ignored in pls[xyz]ax and
    -- therefore it does not make sense to test the returned value.
    Set_Floating_Point_Display_X(3, 0);
    Get_X_Label_Parameters(digmax, digit);
    Put_Line("x axis parameters: digmax, digits ="
        & Integer'image(digmax) & Integer'image(digit));
    if digmax /= 3 then
        Put_Line(Standard_Error, "Get_X_Label_Parameters test failed");
        status := 1;
    end if;

    Set_Floating_Point_Display_Y(4, 0);
    Get_Y_Label_Parameters(digmax, digit);
    Put_Line("y axis parameters: digmax, digits ="
        & Integer'image(digmax) & Integer'image(digit));
    if digmax /= 4 then
        Put_Line(Standard_Error, "Get_Y_Label_Parameters test failed");
        status := 1;
    end if;

    Set_Floating_Point_Display_Z(5, 0);
    Get_Z_Label_Parameters(digmax, digit);
    Put_Line("z axis parameters: digmax, digits ="
        & Integer'image(digmax) & Integer'image(digit));
    if digmax /= 5 then
        Put_Line(Standard_Error, "Get_Z_Label_Parameters test failed");
        status := 1;
    end if;

    mar0 := 0.05;
    aspect0 := PL_NOTSET;
    jx0 := 0.1;
    jy0 := 0.2;
    Set_Device_Window_Parameters(mar0, aspect0, jx0, jy0);
    Get_Device_Window_Parameters(mar, aspect, jx, jy);
    Put_Line("device-space window parameters: mar, aspect, jx, jy = "
        & PF(mar) & " " & PF(aspect) & " " & PF(jx) & " " & PF(jy));
    if mar /= mar0 or jx /= jx0 or jy /= jy0 then
        Put_Line(Standard_Error, "Get_Device_Window_Parameters test failed");
        status := 1;
    end if;

    ori0 := 1.0;
    Set_Plot_Orientation(ori0);
    Get_Plot_Orientation(ori);
    Put_Line("ori parameter = " & PF(ori));
    if ori /= ori0 then
        Put_Line(Standard_Error, "Get_Plot_Orientation test failed");
        status := 1;
    end if;

    xmin0 := 0.1;
    ymin0 := 0.2;
    xmax0 := 0.9;
    ymax0 := 0.8;
    Set_Device_Window_Extrema(xmin0, ymin0, xmax0, ymax0);
    Get_Device_Window_Extrema(xmin, ymin, xmax, ymax);
    Put_Line("plot-space window parameters: xmin, ymin, xmax, ymax = "
        & PF(xmin) & " " & PF(ymin) & " " & PF(xmax) & " " & PF(ymax));
    if xmin /= xmin0 or ymin /= ymin0 or xmax /= xmax0 or ymax /= ymax0 then
        Put_Line(Standard_Error, "Get_Device_Window_Extrema test failed");
        status := 1;
    end if;

    zxmin0 := 0.1;
    zymin0 := 0.1;
    zxmax0 := 0.9;
    zymax0 := 0.9;
    Set_Zoom(zxmin0, zymin0, zxmax0, zymax0);
    Get_Device_Window_Extrema(zxmin, zymin, zxmax, zymax);
    Put_Line("zoomed plot-space window parameters: xmin, ymin, xmax, ymax = "
        & PF(zxmin) & " " & PF(zymin) & " " & PF(zxmax) & " " & PF(zymax));
    if
        abs(zxmin - (xmin + (xmax - xmin) * zxmin0)) > 1.0E-5 or
        abs(zymin - (ymin + (ymax - ymin) * zymin0)) > 1.0E-5 or
        abs(zxmax - (xmin + (xmax - xmin) * zxmax0)) > 1.0E-5 or
        abs(zymax - (ymin + (ymax - ymin) * zymax0)) > 1.0E-5
    then
        Put_Line(Standard_Error, "Set_Zoom test failed");
        status := 1;
    end if;

    Set_Background_Color_RGB(10, 20, 30);
    Get_Background_Color_RGB(r, g, b);
    Put_Line("background colour parameters: r, g, b ="
        & Integer'image(r) & Integer'image(g) & Integer'image(b));
    if r /= 10 or g /= 20 or b /= 30 then
        Put_Line(Standard_Error, "Get_Background_Color_RGB test failed");
        status := 1;
    end if;

    r0 := 20;
    g0 := 30;
    b0 := 40;
    a0 := 0.5;
    Set_Background_Color_RGB_And_Alpha(r0, g0, b0, a0);
    Get_Background_Color_RGB_And_Alpha(r, g, b, a);
    Put_Line("background/transparency colour parameters: r, g, b, a ="
        & Integer'image(r) & Integer'image(g) & Integer'image(b) & " " & PF(a));
    if r /= r0 or g /= g0 or b /= b0 or a /= a0 then
        Put_Line(Standard_Error, "Get_Background_Color_RGBa test failed");
        status := 1;
    end if;

    End_PLplot;
end xstandard31a;