xref: /dports/math/reduce/Reduce-svn5758-src/csl/cslbase/wxshowmath.cpp

// wxshowmath.cpp                       Copyright (C) 2016-2020, A C Norman

/**************************************************************************
 * Copyright (C) 2020, Codemist.                         A C Norman       *
 *                                                                        *
 * Redistribution and use in source and binary forms, with or without     *
 * modification, are permitted provided that the following conditions are *
 * met:                                                                   *
 *                                                                        *
 *     * Redistributions of source code must retain the relevant          *
 *       copyright notice, this list of conditions and the following      *
 *       disclaimer.                                                      *
 *     * Redistributions in binary form must reproduce the above          *
 *       copyright notice, this list of conditions and the following      *
 *       disclaimer in the documentation and/or other materials provided  *
 *       with the distribution.                                           *
 *                                                                        *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS    *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT      *
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS      *
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE         *
 * COPYRIGHT OWNERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,   *
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,   *
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS  *
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND *
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR  *
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF     *
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH   *
 * DAMAGE.                                                                *
 *************************************************************************/

// $Id: wxshowmath.cpp 5555 2020-12-30 22:11:56Z arthurcnorman $


// This is a fresh implementation of this code and will avoid use of
// custom fonts used with wxGraphicsContext - this is bacause in order
// to use custom fontw in a wxGraphicsContext I needed a private extension
// to wxWidgets. The code here should work using a standard copy of wxWidgets.
// To achieve accurate character placement I will use a memory buffer
// rather bigger than the screen and first draw onto that, and then do
// scale reduction to a second buffer sized as per the real window I am
// painting in. That real window will never be bigger than the screen size.


#ifndef __STDC_FORMAT_MACROS
#define __STDC_FORMAT_MACROS 1
#endif

#ifndef __STDC_CONSTANT_MACROS
#define __STDC_CONSTANT_MACROS 1
#endif

#include "wx/wxprec.h"

#ifndef WX_PRECOMP
#include"wx/wx.h"
#endif

#include <wx/display.h>
#include <wx/graphics.h>
#include <wx/filename.h>
#include <wx/rawbmp.h>

#include"config.h"

#include "wxfwin.h"

#ifdef WIN32
#include <windows.h>
#endif  // WIN32

// I may be old fashioned, but I will be happier using C rather than C++
// libraries here.

#include <cstring>
#include <cstdlib>
#include <cstdio>
#include <cstdarg>
#include <cctype>
#include <ctime>
#include <csignal>
#include <cstdint>
#include <cinttypes>

#if HAVE_UNISTD_H
#include <unistd.h>
#else
extern char *getcwd(char *s, size_t n);
#endif // HAVE_UNISTD_H

#include <sys/stat.h>
#include <sys/types.h>
#include <errno.h>

#ifdef HAVE_DIRENT_H
#include <dirent.h>
#else
#ifndef WIN32
#include <sys/dir.h>
#else
#include <direct.h>
#endif
#endif // HAVE_DIRENT_H

#if !defined __WXMSW__ && !defined __WXPM__
#include"fwin.xpm" // Icon to use in non-Windows cases
#endif

// I have a generated file that contains the widths of all the fonts
// that I am willing to use here.

#include "uninames.h"
#include "charmetrics.h"

static wxStopWatch sw;

static int options = 5;  // default to using my own scaling

static std::FILE *logFile = nullptr;

static int printlog(const char *fmt, ...)
{   std::va_list a;
    int r = 0;
    if (logFile == nullptr) logFile = std::fopen("wxshowmath.log", "w");
    if (logFile != nullptr)
    {   va_start(a, fmt);
        r = std::vfprintf(logFile, fmt, a);
        std::fflush(logFile);
        va_end(a);
    }
#ifndef MACINTOSH
// On systems other than the Mac I expect I can (sometimes!) have a console
// attached to my program, and in that case it will be convenient to sent the
// trace output there as well as to a file.
    va_start(a, fmt);
    r = std::vprintf(fmt, a);
    va_end(a);
    std::fflush(stdout);
#endif
    return r;
}

class showmathApp : public wxApp
{
public:
    virtual bool OnInit();
};

#define MAX_FONTS 16
wxFont *Font[MAX_FONTS];
int Baseline[MAX_FONTS];
bool FontValid[MAX_FONTS];


class showmathPanel : public wxPanel
{
public:
    showmathPanel(class showmathFrame *parent,
                  const char *showmathFilename);

    void OnPaint(wxPaintEvent &event);

// The event handling is not really needed for this application, but I
// am putting some in so I can experiment with it!
    void OnChar(wxKeyEvent &event);
    void OnKeyDown(wxKeyEvent &event);
    void OnKeyUp(wxKeyEvent &event);
    void OnMouse(wxMouseEvent &event);

    wxFont FixedPitch;
    int FixedPitchBaseline;

    char *showmathData;  // the .showmath file's contents are stored here

    DECLARE_EVENT_TABLE()
};

BEGIN_EVENT_TABLE(showmathPanel, wxPanel)
    EVT_PAINT(           showmathPanel::OnPaint)
    EVT_CHAR(            showmathPanel::OnChar)
//  EVT_KEY_DOWN(        showmathPanel::OnKeyDown)
//  EVT_KEY_UP(          showmathPanel::OnKeyUp)
    EVT_LEFT_UP(         showmathPanel::OnMouse)
END_EVENT_TABLE()

// The size (in pixels, or at least in the units that wxWidgets uses)
// of my screen. No window can ever be bigger than this.
int screenWidth, screenHeight;

wxBitmap *bigBitmap;
wxMemoryDC *bigDC;
// I have bigBitmap which is bigWidth*bigHeight, which is 4 times the
// size of my screen (well my screen as reported and worked with by
// wxWidgets). Eg for a HD monitor that means it will be 7680x4320 which
// is 31 megapixels. It turns out to be VITALLY IMPORTANT for performance
// that I make this bitmnap have the same depth as my screen. It ends up
// using quite a lot of memory!

int bigWidth, bigHeight;

// I will limit the area of my window to the size of my screen, and so once
// borders (and perhaps scroll bars and other decorations) have been allowed
// for the client area will be strictly smaller. The size of it is recorded
// here.

int clientWidth, clientHeight;

// The client area will be mapped by a region in the top left hand corner of
// bigBitmap. This will be larger by some factor that is in the range 3.5
// to 4. usedScale records this scale factor and usedWidth and usedHeight
// the size of this area. Note that the constraints I have documented ensure
// that this fits within bigBitmap. I am going to arrange that usedWidth is
// either a multiple of 80 or only a few pixels larger. That is so that I can
// fit a row of 80 fixed-pitch characters across my window neatly.

double usedScale;
int usedWidth, usedHeight;

// To help me redraw the client area of my screen reasonably rapidly I
// will work with tiles, and I will require usedScale to be a rational
// number bigTileSize/smallTileSize. Then I will have usedWidth as
// ceiling(usedScale*clientWidth) and usedHeight = celing(usedScale*
// clientHeight). If I do this I can align my tiles precisely on both
// client and big bitmaps. Vertical measurements are in charOffset and
// charLinespacing, and pointSize records the point size passed
// to wxWidgets to create the font. To help me choose a suitable point size
// I record charWidth_1000 which is the width of a 1000-point character.

wxBitmap *bigTile = nullptr;
wxBitmap *smallTile = nullptr;
wxMemoryDC *tileDC;
int smallTileSize, bigTileSize;

// bigFont is a fixed pitch font sized for use on bigBitmap, such that
// each character there has width charWidth, and usedWidth is just over
// 80*charWidth. The latter is so that the line neatly fills my window.

wxFont *bigFont;

// A maths font...
wxFont *mathFont;

int pointSize;   // size of the font.
int charWidth_1000;  // width of characters when font is 1000 points.
int charWidth;       // for fixed pitch font, as on bigBitmap.
int charOffset;      // so that I print relative to index point.
int charLinespace;   // how much to separate lines by.

// Once I have done all that I intend to set a wxWidgets UserScale so that
// the user works using integer coordinates such that the apparent point size
// of the fixed point font is 10000 -- I intend to think of this as working
// in millipoints, and it amounts to pretending that the fixed pitch
// font I am working with is at 10 points (even though on screen it will
// typically be larger).

// The scale factor between bigBitmap and the client area means that I
// will initially position and render characters between 3.5 and 4 times as
// precisely as single-pixel addressing would have allowed. Copying down from
// bigBitmap to the screen will do anti-aliasing and support sub-pixel
// character placement. I may need to experiment to decide if this reduction
// factor is about right, but at present my guess is that it will give
// usefully better visual effects than schemes that force all characters to
// snap to pixels, and that more oversampling would bot gain anything
// worth while. And the cost of what I am doing now is perhaps already
// fairly bad.


class showmathFrame : public wxFrame
{
public:
    showmathFrame(const char *showmathFilename);

    void RepaintBuffer();

    void OnClose(wxCloseEvent &event);
    void OnExit(wxCommandEvent &event);
    void OnAbout(wxCommandEvent &event);
    void OnSize(wxSizeEvent &event);

private:
    showmathPanel *panel;
    DECLARE_EVENT_TABLE()
};

BEGIN_EVENT_TABLE(showmathFrame, wxFrame)
    EVT_CLOSE(           showmathFrame::OnClose)
    EVT_MENU(wxID_EXIT,  showmathFrame::OnExit)
    EVT_MENU(wxID_ABOUT, showmathFrame::OnAbout)
    EVT_SIZE(            showmathFrame::OnSize)
END_EVENT_TABLE()

#ifndef LONGEST_LEGAL_FILENAME
#define LONGEST_LEGAL_FILENAME 1024
#endif

int main(int argc, char *argv[])
{   int usegui = 1;
// Find where I am invoked from before doing anything else
    find_program_directory(argv[0]);
// The next fragment is not very useful in THIS program but stands in for
// behaviour I want in more complicated cases.
    for (int i=1; i<argc; i++)
    {   if (std::strncmp(argv[i], "-w", 2) == 0) usegui = 0;
        if (std::strncmp(argv[i], "-x",
                         2) == 0) options = std::atoi(argv[i]+2);
    }
#if !defined WIN32 && !defined MACINTOSH
// Under X11 I will demote to being a console mode application if DISPLAY
// is not set. This is not a perfect test but it will spot the simple
// cases. Eg I could look at stdin & stdout and check if it looks as if
// they are pipes of they have been redirected...
    {   const char *s = std::getenv("DISPLAY");
        if (s==nullptr || *s == 0) usegui = 0;
    }
#endif
    if (usegui)
    {
#ifdef MACINTOSH
// If I will be wanting to use a GUI and if I have just loaded an
// executable that is not within an application bundle then I will
// use "open" to launch the corresponding application bundle. Doing this
// makes resources (eg fonts) that are within the bundle available and
// it also seems to cause things to terminate more neatly.
        char xname[LONGEST_LEGAL_FILENAME];
        std::sprintf(xname,"%s.app", programName);
        if (std::strstr(fullProgramName, xname) == nullptr)
        {
// Here the binary I launched was not located as
//      ...foo.app../.../foo
// so I will view it is NOT being from an application bundle. I will
// re-launch it so it is! This may be a bit of a hacky way to decide!
            struct stat buf;
            std::sprintf(xname,"%s.app", fullProgramName);
            if (stat(xname, &buf) == 0 &&
                (buf.st_mode & S_IFDIR) != 0)
            {
// Well foo.app exists and is a directory, so I will try to use it
                const char **nargs =
                    new (std::nothrow) char *[argc+3];
                if (nargs == nullptr) my_abort();
                nargs[0] ="/usr/bin/open";
                nargs[1] = xname;
                nargs[2] ="--args";
                for (int i=1; i<argc; i++)
                    nargs[i+2] = argv[i];
                nargs[argc+2] = nullptr;
// /usr/bin/open foo.app --args [any original arguments]
                return execv("/usr/bin/open", const_cast<char * const *>(nargs));
            }
        }
#endif
// I have my own "main" function and call wxEntry from it. So I need
// to call the following so that if I compiled with NDEBUG set a range of
// assertions etc will not be checked...
        wxDISABLE_DEBUG_SUPPORT();
        add_custom_fonts();
#if DEBUG
//      display_font_information();
#endif
        return wxEntry(argc, (char **)argv);
    }
//
// The following is a bit silly but is here to prove that I can launch this
// code in console mode if I wish to. In this case it is not very useful!
//
    std::printf("This program has been launched asking for use in a console\n");
    std::printf("type a line of text please\n");
    int c;
    while ((c = std::getchar()) != '\n' && c != EOF) std::putchar(c);
    std::putchar('\n');
    std::printf("Exiting from demonstration of console mode use!\n");
    return 0;
}

IMPLEMENT_APP_NO_MAIN(showmathApp)

//=========================================================================
//
// Now that start of my code in a proper sense!
//
//

bool showmathApp::OnInit()
{
// The program can take an argument - grab that here and pass it down to
// showmathFrame - or nullptr if there was none.
    char **myargv = (char **)argv;
    const char *showmathFilename = nullptr;
    for (int i=1; i<argc; i++)
        if (myargv[i][0] != '-') showmathFilename = myargv[i];
#ifdef WIN32
    static char tidyFilename[LONGEST_LEGAL_FILENAME];
    if (showmathFilename != nullptr &&
        std::strncmp(showmathFilename, "/cygdrive/", 10) == 0 &&
        showmathFilename[11] == '/')
    {   std::sprintf(tidyFilename, "%c:%s",
                     showmathFilename[10], showmathFilename+11);
        showmathFilename = tidyFilename;
    }
#endif
    sw.Start(0);  // start the StopWatch
    showmathFrame *frame = new showmathFrame(showmathFilename);
    frame->Show(true);
    return true;
}

showmathFrame::showmathFrame(const char *showmathFilename)
    : wxFrame(nullptr, wxID_ANY, "wxshowmath")
{   SetIcon(wxICON(fwin));
    panel = new showmathPanel(this, showmathFilename);
    int numDisplays = wxDisplay::GetCount(); // how many displays?
// It is not clear to me what I should do if there are several displays,
// and if there are none I am probably in a mess!
    if (numDisplays != 1)
    {   printlog("There seem to be %d displays\n", numDisplays);
    }
    wxDisplay d0(0);                         // just look at display 0
    wxRect screenArea(d0.GetClientArea());   // omitting task bar
    screenWidth = screenArea.GetWidth();
    screenHeight = screenArea.GetHeight();

    bigBitmap = new wxBitmap(bigWidth=4*screenWidth,
                             bigHeight=4*screenHeight,
                             24); // wxBITMAP_SCREEN_DEPTH);
    bigDC = new wxMemoryDC();
    bigTile = nullptr;
    smallTile = nullptr;
    tileDC = new wxMemoryDC();
    bigDC->SelectObject(*bigBitmap);
//
// I will now create a font suitable for writing into the big
// bitmap. Well here I will just make one using "CMU Typewriter Text", a
// fixed pitch font. I start by creating a font that is 1000 points. This
// is of course ridiculously big, but maybe it lets me measure widths
// accurately. Actually the size I use here is not that important and
// I will (repeatedly) change it later on.
    wxFontInfo bigfi(1000);
    bigfi.FaceName("CMU Typewriter Text");
    bigFont = new wxFont(bigfi);
    mathFont = new wxFont(wxFontInfo(10).FaceName(wxT("cslSTIXMath")));
    bigDC->SetFont(*bigFont);
    int w, h, d, xl;
    bigDC->GetTextExtent("X", &w, &h, &d, &xl);
    charWidth_1000 = w;
    bigDC->SelectObject(wxNullBitmap);
// I am now going to pick a default initial size for the client area
// of my main window. The choice here is perhaps somewhat arbitrary and
// may only be good for MY screen.
    clientWidth = 640;
    clientHeight = 880;
// If the default size would fill over 90% of screen width or height I
// clip it down to make it fit better. The consequence of this is that on
// computers in general the window size may not end up a neat multiple
// of anything in particular.
    if (10*clientWidth > 9*screenWidth) clientWidth = 90*screenWidth/100;
    if (10*clientHeight > 9*screenHeight) clientHeight =
            90*screenHeight/100;
    SetClientSize(clientWidth, clientHeight);
// I put a minimum on the client size...
    SetMinClientSize(wxSize(400, 100));
// ... but a maximum on the total size including borders and decorations.
    SetMaxSize(wxSize(screenWidth, screenHeight));
    RepaintBuffer(); // I must get an image ready before I first try to
    // display the window.
    Centre();
    Refresh();          // Force full re-draw so it appears on-screen
}

int bestP, bestQ, bestErr;

// Check all rational numbers in a given range so I can see which
// one will work best for me. Look up "Farey Sequence" for more insight.

void farey(int p1, int q1, int p2, int q2, int maxQ)
{   int uw = (p2 * clientWidth)/q2;
    int err = uw % 80;
    if (err <= bestErr)
    {   if (err < bestErr || q2 < bestQ)
        {   bestP = p2;
            bestQ = q2;
        }
        bestErr = err;
    }
    int p = p1 + p2;
    int q = q1 + q2;
    if (q > maxQ) return;
    farey(p1, q1, p, q, maxQ);
    farey(p, q, p2, q2, maxQ);
}

#if 0
// When I was developing this code I ran this fragment to help me judge how
// large denominators would be useful. I record the following table of
// which shows how large a denominator must be accepted in order to
// limit the gap at the right hand end of the line to a given number of
// pixels for all possible client widths in the range 400..2000.
//        gap  necessary denominator
//         10          13
//          8          16
//          6          18
//          5          19
//          4          22
//          3          25  <<<< my choice
//          2          31
//          1          40
//          0          53
// Based on this table I pick 25 as my cut-off.
for (int m = 2; m<80; m++)
{   int cw = clientWidth;
    int maxQ = m;
    int worstErr = 0;
    int Q = 0, WW = 0;
    for (clientWidth = 400; clientWidth <=2000; clientWidth++)
    {   bestP = 7;
        bestQ = 2;
        int uw = (bestP * clientWidth)/bestQ;
        bestErr = uw % 80;
        farey(7, 2, 4, 1, maxQ);
        if (bestErr > worstErr)
        {   worstErr = bestErr;
            WW = clientWidth;
            Q = bestQ;
        }
    }
    printlog("at maxQ = %d see err = %d at cw=%d, Q=%d\n",
             m, worstErr, WW, Q);
    clientWidth = cw;
}
#endif

// The map of tiles here can cover 64*64 tiles in all.  The small tiles
// can be from 20x20 to 120*120 so that this can deal with a raw display
// area up to 7680x7680, which is ridiculously large by the standards of
// the year in which this code is being written.

static uint64_t tileMap[64];

#define maxSmallTileSize 120
#define maxBigTileSize (4*maxSmallTileSize)

static int32_t convert_font_name(char *dest, char *src)
{
// The font name passed should be one of
//    cmuntt
//    odokai
//    math
//    <anything else>
//    <anything else>-Bold
//    <anything else>-Italic
//    <anything else>-BoldItalic
//
    int32_t r = wxFONTFLAG_DEFAULT;
    if (std::strcmp(src, "cmuntt") == 0) std::strcpy(dest,
                "CMU Typewriter Text");
    else if (std::strcmp(src, "odokai") == 0) std::strcpy(dest,
                "AR PL New Kai");
    else if (std::strcmp(src, "Math") == 0) std::strcpy(dest,
                "cslSTIXMath");
    else std::sprintf(dest, "cslSTIX");
// Here if the font name is suffixed as "-Bold" or "-Italic" or "-BoldItalic"
    if (std::strcmp(dest,
                    "CMU Typewriter Text") == 0) r |= (F_cmuntt<<16);
    else if (std::strcmp(dest, "AR PL New Kai") == 0) r |= (F_odokai<<16);
    else if (std::strcmp(dest, "cslSTIXMath") == 0) r |= (F_Math<<16);
// I have not thought through and implemented support for bold and italic
// options here...
#ifdef PENDING_BOLD_AND_ITALIC
    else if ((r & (wxFONTFLAG_BOLD + wxFONTFLAG_ITALIC)) ==
             (wxFONTFLAG_BOLD + wxFONTFLAG_ITALIC)) r |= (F_BoldItalic<<16);
    else if ((r & wxFONTFLAG_BOLD) ==
             wxFONTFLAG_BOLD) r |= (F_Bold<<16);
    else if ((r & wxFONTFLAG_ITALIC) ==
             wxFONTFLAG_ITALIC) r |= (F_Italic<<16);
    else
#endif
        r |= (F_Regular<<16);
    printlog("Gives %s with flags %x\n", dest, r); std::fflush(stdout);
    return r;
}

// I want to use the whole range of Unicode, and in particular I wish to
// use characters beyond U+FFFF. If I am using a computer where wchar_t
// is 16-bits I will need to do that by transmitting the code using
// UTF-16. This applies on Windows. If I am on a machine where
// wchar_t is a 32-bit type I can use a single unit to represent any
// codepoint at all. This function adjusts...

static void allow_for_utf16(wchar_t *ccc, int cp)
{   if (sizeof(wchar_t) == 4 ||
        cp <= 0xffff)
    {   ccc[0] = cp;
        ccc[1] = 0;
    }
    else
    {   cp = (cp - 0x10000) & 0xfffff;
        ccc[0] = 0xd800 + (cp >> 10);
        ccc[1] = 0xdc00 + (cp & 0x3ff);
        printlog("Char mapped to %x %x\n", ccc[0], ccc[1]);
        ccc[2] = 0;
    }
}

void showmathFrame::RepaintBuffer()
{   printlog("RepaintBuffer called\n");
// Now that I know how big by client window will be I can work out how
// much of the big bitmap I will use.
    bestP = 7;
    bestQ = 2;
    int uw = (bestP * clientWidth)/bestQ;
    bestErr = uw % 80;
    farey(7, 2, 4, 1, 25);
// My small tiles will have an ideal size such that there are about 64 of
// them across the window. If the window is narrow I will keep the size
// at least 20 pixels. So each tile is slightly larger than a single
// character. I will also limit things so that the window is no more than
// 64 tiles high.
    {   int nw = (clientWidth + 63)/64;  // ideal width
        int nh = (clientHeight + 63)/64; // ideal height
        int n = nh > nw ? nh : nw;       // use the larger
        if (n < 20) n = 20;
        int r = (n + bestQ - 1)/bestQ;
        bigTileSize = r*bestP;
        smallTileSize = r*bestQ;
    }
    printlog("Small tiles are %d square, with %d*%d covering window\n",
             smallTileSize,
             (clientWidth+smallTileSize-1)/smallTileSize,
             (clientHeight+smallTileSize-1)/smallTileSize);
    if (bigTile != nullptr) delete bigTile;
    bigTile =
        new wxBitmap(bigTileSize, bigTileSize, 24); // wxBITMAP_SCREEN_DEPTH);
    if (smallTile != nullptr) delete smallTile;
    smallTile =
        new wxBitmap(smallTileSize, smallTileSize,
                     24); // wxBITMAP_SCREEN_DEPTH);
// The used region of the big bitmap will be bestP/bestQ times the size of
// the client area. Well that might not be exactly an integer, so I will
// round up here, and what I will end up with will be a width that is 0, 1,
// 2, 3 or 4 modulo 80. When scaled down to the client area that means that
// I can expect 80 columns of text to come within a pixel of the width. That
// seems like pretty good fitting to me.
    usedWidth = (bestP*clientWidth + bestQ - 1)/bestQ;
    usedHeight = (bestP*clientHeight + bestQ - 1)/bestQ;
    bigDC->SelectObject(
        *bigBitmap); // Writing to the DC writes into bitmap
// Predict a point size to use...
    pointSize = (usedWidth*1000 + 40*charWidth_1000)/(80*charWidth_1000);
// There us a potential danger that xWidgets create a font here that was
// not exactly what I wanted - and in particular that it might have created
// one (slightly) bigger than I wanted, leading to 80 characters not fitting
// neatly on the line. If that is the case I will decrease the requested
// point size by 1 and try again. Equally I could at least imagine the
// font ending up too small, in which case I will make it larger.
    int width, height, descent, xleading;
    for (;;)
    {   bigFont->SetPointSize(pointSize);
        mathFont->SetPointSize(pointSize);
        bigDC->SetFont(*bigFont);
        bigDC->GetTextExtent("X", &width, &height, &descent, &xleading);
        if (80*width > usedWidth) pointSize--;
        if (80*width <= usedWidth-80) pointSize++;
        charWidth = width;
        charOffset = height - descent;
        charLinespace = height + xleading;
        break;
    }
    printlog("Now 80 chars should have with %d in bigBitmap (cf %d)\n",
             80*charWidth, usedWidth);


// Now I should find how all my fonts will be arranged in terms of the
// distance from the index point used by wxWidgets to the font base-line
// as relevent in .afm metrics. Horribly this is something that seems
// to be platform dependent, but rather than just testing what system I am
// building on I will run some code to measure and make my choices on that
// basis. The cases I check are ones that I believe reveal the differences!
// This seems hideously hacky.
    for (;;)
    {   int depth, leading;
        wxFont tf1(wxFontInfo(10000).FaceName(
                       wxT("cslSTIX")).Bold().Italic());
        bigDC->SetFont(tf1);
        bigDC->GetTextExtent(wxString((wchar_t)'X'),
                             &width, &height, &depth, &leading);
        printlog("%d %d [%d]\n", height, depth, height-depth);
        if ((height - depth + 5)/10 == chardepth_WIN32[F_BoldItalic])
        {   chardepth = chardepth_WIN32;
            break;
        }
        tf1.SetStyle(wxFONTSTYLE_NORMAL);
        tf1.SetFaceName(wxT("AR PL New Kai"));
        bigDC->SetFont(tf1);
        bigDC->GetTextExtent(wxString((wchar_t)'X'),
                             &width, &height, &depth, &leading);
        printlog("%d %d [%d]\n", height, depth, height-depth);
        if ((height - depth + 5)/10 == chardepth_X11[F_odokai])
        {   chardepth = chardepth_X11;
            break;
        }
        tf1.SetFaceName(wxT("cslSTIXMath"));
        bigDC->SetFont(tf1);
        bigDC->GetTextExtent(wxString((wchar_t)unicode_INTEGRAL),
                             &width, &height, &depth, &leading);
        printlog("%d %d [%d]\n", height, depth, height-depth);
        if ((height - depth + 5)/10 == chardepth_OSX[F_Math])
        {   chardepth = chardepth_OSX;
            break;
        }
        printlog("\n+++ Character positioning not recognized\n");
        chardepth = chardepth_X11;
        break;
    }
    bigDC->SetFont(*bigFont);

//
// Now so that I can see what is going in a bit I will draw a row of
// characters across the top of bigBitmap...
    bigDC->SetBackground(*wxWHITE_BRUSH);
    bigDC->Clear();
    for (int i=0; i<80; i++)
    {   bigDC->DrawText(wxString((wchar_t)(i+0x21)),
                        i*charWidth,
                        charLinespace - charOffset);
    }
#if 1
// Draw blocks every 1000 pixels in bigBitmap
    bigDC->SetBrush(*wxYELLOW_BRUSH);
    for (int i=0; i<usedWidth; i+=1000)
        bigDC->DrawRectangle(i, 2*charLinespace, 500, charLinespace);
#endif

// Next I move to draw some stuff that is a bit more "mathsy"
    wxFont regular(wxFontInfo(pointSize).FaceName(wxT("cslSTIX")));
    bigDC->SetFont(regular);
    bigDC->GetTextExtent(wxString((wchar_t)'x'), &width, &height,
                         &descent, &xleading);
    printlog("%d %d %d %d regular\n", width, height, descent, xleading);
    int regularBaseline = height - descent;
    printlog("regular baseline = %d\n", regularBaseline);

    bigDC->SetFont(*mathFont);
    bigDC->GetTextExtent(wxString((wchar_t)'x'), &width, &height,
                         &descent, &xleading);
    printlog("%d %d %d %d math\n", width, height, descent, xleading);
    int mathBaseline = height - descent;
    printlog("math baseline = %d\n", mathBaseline);

// cslSTIXMath puts the glyphs used to build up big delimiters in a
// private use area. It expects the code to use maths tables to discover
// where they are rather than mere unicode names. But for this test and
// demonstration I will just use absolute code-points.

#define stix_LEFT_CURLY_BRACKET_UPPER_HOOK    0x10821c
#define stix_LEFT_CURLY_BRACKET_MIDDLE_PIECE  0x10821d
#define stix_CURLY_BRACKET_EXTENSION          0x10821f
#define stix_LEFT_CURLY_BRACKET_LOWER_HOOK    0x10821e

    lookupchar(F_Math, stix_LEFT_CURLY_BRACKET_UPPER_HOOK);
    printlog("upper hook   %d %d\n", c_lly, c_ury);
    lookupchar(F_Math, stix_LEFT_CURLY_BRACKET_MIDDLE_PIECE);
    printlog("middle piece %d %d\n", c_lly, c_ury);
    lookupchar(F_Math, stix_LEFT_CURLY_BRACKET_LOWER_HOOK);
    printlog("lower hook   %d %d\n", c_lly, c_ury);
    lookupchar(F_Math, stix_CURLY_BRACKET_EXTENSION);
    printlog("extension    %d %d\n", c_lly, c_ury);

    double s = static_cast<double>(pointSize)/10.0;
#define H (10.0)
#define XX 120.0
#define YY 100.0
    {   wchar_t ccc[4];
        allow_for_utf16(ccc, stix_LEFT_CURLY_BRACKET_UPPER_HOOK);
        printlog("Character %#x %#x\n", ccc[0], ccc[1]);
        bigDC->DrawText(wxString(ccc), s*XX, s*(YY-H)-mathBaseline);
        allow_for_utf16(ccc, stix_LEFT_CURLY_BRACKET_MIDDLE_PIECE);
        bigDC->DrawText(wxString(ccc), s*XX, s*YY-mathBaseline);
        allow_for_utf16(ccc, stix_CURLY_BRACKET_EXTENSION);
        bigDC->DrawText(wxString(ccc), s*XX, s*(YY+H)-mathBaseline);
        allow_for_utf16(ccc, stix_LEFT_CURLY_BRACKET_LOWER_HOOK);
        bigDC->DrawText(wxString(ccc), s*XX, s*(YY+2.0*H)-mathBaseline);
    }
// The next two have codepoints in the Basic Multilingual Plane so
// I do not need to mess around with encoding even on platforms like
// Windows that use UTF16 internally.
    bigDC->SetFont(regular);
    bigDC->DrawText(wxString((wchar_t)unicode_GREEK_SMALL_LETTER_OMEGA),
                    s*XX, s*(YY+100.0)-regularBaseline);
    bigDC->DrawText(wxString((wchar_t)
                             unicode_RIGHT_ANGLE_WITH_DOWNWARDS_ZIGZAG_ARROW),
                    s*(XX+100.0), s*(YY+100.0)-regularBaseline);
// Now I will try a row of text.Or some material provided on an input file.
    const char *in = panel->showmathData;
    printlog("About to process data:\n\"%.70s\"... ...\n\n", in);
    do
    {   int x, y, n, cp, size;
        char name[100], name1[64];
        while (std::isspace(*in)) in++;
        if (*in == 0) break;
        if (*in == '#' || *in == '%')
// # ...     comments extend to the end of the line
// % ...
        {   n = 0;
            while (*in != 0 && *in != '\n')
                if (n < 99) name[n++] = *in++;
                else in++;
            name[n] = 0;
            printlog("%s\n", name);
            if (*in == '\n') in++;
            continue;
        }
        else if (std::sscanf(in, "deffont %d %60s %d;", &n, name,
                             &size) == 3 &&
// deffont number name size;   define font with given number
                 0 <= n &&
                 n < MAX_FONTS)
        {   int flags = convert_font_name(name1, name);
            int col;
            printlog("font[%d] = \"%s\" size %d\n", n, name1, size);
            Font[n] =
                new wxFont(wxFontInfo((pointSize*size*5)/144).FaceName(name1));
            bigDC->SetFont(*Font[n]);
            bigDC->GetTextExtent(wxString((wchar_t)'('), &width, &height,
                                 &descent, &xleading);
            printlog("( %s/%d: %d %d [%d]\n",
                     name1, size, height, descent, height-descent);
            col = printlog("    %d,",
                           static_cast<int>((height - descent)/10.0 + 0.5));
            while (col++ < 20) printlog(" ");
            printlog("// %s\n", name);
            Baseline[n] =   // This still needs review!
                size * chardepth[(flags >> 16) & 0x1f] / 1000.0;
            printlog("from table baseline offset = %.6g\n", Baseline[n]);
        }
        else if (std::sscanf(in, "put %d %d %d 0x%x;", &n, &x, &y,
                             &cp) == 4 ||
                 std::sscanf(in, "put %d %d %d %d;", &n, &x, &y, &cp) == 4)
        {
// put fontnum xpos ypos codepoint;  dump character onto screen
// note x & y in units of 1/1000 point.
//          printlog("Font %d (%d,%d) char %d = %#x\n", n, x, y, cp, cp);
            bigDC->SetFont(*Font[n]);
            wchar_t ccc[4];
// For the benefit of Windows I need to represent code points in other
// then the basic multilingual pane as surrogate pairs. Well that will
// probably apply anywhere where sizeof(wchar_t) < 4.
            allow_for_utf16(ccc, cp);
            bigDC->DrawText(wxString(ccc),
                            (s*x)/2400, s*150 + (400-y)/2400); //-graphicsBaseline[n]);
        }
        else printlog("\nLine <%.32s> unrecognised\n", in);
        in = std::strchr(in, ';');
        if (in != nullptr) in++;
    }
    while (in != nullptr);

// I will mark all the fonts I might have created as invalid now
// that the context they were set up for is being left.
    for (int i=0; i<MAX_FONTS; i++) FontValid[i] = false;
    bigDC->SelectObject(wxNullBitmap);
    return;
}

static char default_data[4096] =
    "deffont 1 Regular 24;"
    "put 1 -408 0 84;"
    "put 1 14256 0 104;"
    "put 1 26256 0 101;"
    "put 1 36912 0 32;"
    "put 1 42912 0 98;"
    "put 1 54912 0 111;"
    "put 1 66384 0 121;"
    "put 1 78384 0 32;"
    "put 1 84384 0 115;"
    "put 1 93528 0 116;"
    "put 1 100152 0 111;"
    "put 1 112152 0 111;"
    "put 1 124152 0 100;"
    "put 1 136152 0 32;"
    "put 1 142152 0 111;"
    "put 1 154152 0 110;"
    "put 1 166152 0 32;"
    "put 1 172152 0 116;"
    "put 1 179016 0 104;"
    "put 1 191016 0 101;"
    "put 1 201672 0 32;"
    "put 1 207672 0 98;"
    "put 1 219672 0 117;"
    "put 1 231672 0 114;"
    "put 1 240168 0 110;"
    "put 1 252168 0 105;"
    "put 1 258840 0 110;"
    "put 1 270840 0 103;"
    "put 1 282840 0 32;"
    "put 1 288840 0 100;"
    "put 1 300840 0 101;"
    "put 1 311496 0 99;"
    "put 1 321624 0 107;"
    "put 1 333744 0 44;"
    "put 1 339744 0 32;"
    "put 1 345744 0 119;"
    "put 1 363072 0 104;"
    "put 1 375072 0 101;"
    "put 1 385728 0 110;"
    "put 1 397728 0 99;"
    "put 1 408384 0 101;"
    "put 1 419040 0 32;"
    "put 1 425040 0 97;"
    "put 1 435696 0 108;"
    "put 1 442368 0 108;"
    "put 1 449040 0 32;"
    "put 1 455040 0 98;"
    "put 1 467040 0 117;"
    "put 1 479040 0 116;"
    "put 1 485712 0 32;"
    "put 1 491712 0 104;"
    "put 1 503712 0 101;"
    "put 1 514368 0 32;"
    "put 1 520368 0 104;"
    "put 1 532368 0 97;"
    "put 1 543024 0 100;"
    "put 1 555024 0 32;"
    "put 1 561024 0 102;"
    "put 1 570072 0 108;"
    "put 1 576744 0 101;"
    "put 1 587400 0 100;"
    "put 1 599400 0 46;";

// When I construct this I must avoid the wxTAB_TRAVERSAL style since that
// tends to get characters passed to child windows not this one. Avoiding
// that is the reason behind providing so many arguments to the parent
// constructor

showmathPanel::showmathPanel(showmathFrame *parent,
                             const char *showmathFilename)
    : wxPanel(parent, wxID_ANY, wxDefaultPosition,
              wxDefaultSize, 0L,"showmathPanel")
{
// I will read in any data once here and put it in a character buffer.
    std::FILE *f = nullptr;
    if (showmathFilename == nullptr) showmathData = default_data;
    else
    {   int i;
        f = std::fopen(showmathFilename,"r");
        if (f == nullptr)
        {   printlog("File \"%s\" not found\n", showmathFilename);
            std::exit(1);
        }
        std::fseek(f, (off_t)0, SEEK_END);
        off_t len = std::ftell(f);
        showmathData = new char[4+(size_t)len];
        std::fseek(f, (off_t)0, SEEK_SET);
        for (i=0; i<len; i++) showmathData[i] = std::getc(f);
        showmathData[i] = 0;
        std::fclose(f);
    }
    for (int i=0; i<MAX_FONTS; i++)
    {   FontValid[i] = false;
        Baseline[i] = 0;
    }
}


void showmathFrame::OnClose(wxCloseEvent &WXUNUSED(event))
{   Destroy();
#ifdef WIN32
// Otherwise under XP bad things happen for me. Like the application
// re-launching. I do not think I understand, but the extreme action of
// utterly killing the process does what I need!
    TerminateProcess(GetCurrentProcess(), 1);
#else
    std::exit(0);    // I want the whole application to terminate here!
#endif
}

void showmathFrame::OnExit(wxCommandEvent &WXUNUSED(event))
{   Destroy();
#ifdef WIN32
    TerminateProcess(GetCurrentProcess(), 1);
#else
    std::exit(0);    // I want the whole application to terminate here!
#endif
}

void showmathFrame::OnAbout(wxCommandEvent &WXUNUSED(event))
{
// At present this never gets activated!
    wxMessageBox(
        wxString::Format(
            "wxshowmath (A C Norman 2016)\n"
            "wxWidgets version: %s\n"
            "Operating system: %s",
            wxVERSION_STRING,
            wxGetOsDescription()),
        "About wxshowmath",
        wxOK | wxICON_INFORMATION,
        this);
}

void showmathFrame::OnSize(wxSizeEvent &WXUNUSED(event))
{   wxSize clientSize(GetClientSize());
    int w = clientSize.GetWidth(), h = clientSize.GetHeight();
    if (clientWidth == w) printlog("Width has not changed\n");
    if (clientHeight == h) printlog("Height has not changed\n");
//  if (clientWidth == w && clientHeight == h) return;
    clientWidth = w;
    clientHeight = h;
    printlog("New window size %d*%d\n", clientWidth, clientHeight);
    panel->SetSize(clientWidth, clientHeight);
    printlog("About to repaint\n");
    RepaintBuffer();
    printlog("Completed repaint\n");
    Refresh();
}

void showmathPanel::OnChar(wxKeyEvent &event)
{
// This merely records the character in the log file.
    const char *msg ="OnChar", *raw ="";
    int c = event.GetUnicodeKey();
    if (c == WXK_NONE) c = event.GetKeyCode(), raw ="Raw";
    if (0x20 < c && c < 0x7f) printlog("%s%s %x (%c)\n", msg, raw, c, c);
    else printlog("%s%s %x\n", msg, raw, c);
}

void showmathPanel::OnKeyDown(wxKeyEvent &event)
{
// Again merely log the event.
    const char *msg ="OnKeyDown", *raw ="";
    int c = event.GetUnicodeKey();
    if (c == WXK_NONE) c = event.GetKeyCode(), raw ="Raw";
    if (0x20 < c && c < 0x7f) printlog("%s%s %x (%c)\n", msg, raw, c, c);
    else printlog("%s%s %x\n", msg, raw, c);
    event.Skip();
}

void showmathPanel::OnKeyUp(wxKeyEvent &event)
{
// Merely log the event.
    const char *msg ="OnKeyUp", *raw ="";
    int c = event.GetUnicodeKey();
    if (c == WXK_NONE) c = event.GetKeyCode(), raw ="Raw";
    if (0x20 < c && c < 0x7f) printlog("%s%s %x (%c)\n", msg, raw, c, c);
    else printlog("%s%s %x\n", msg, raw, c);
    event.Skip();
}

void showmathPanel::OnMouse(wxMouseEvent &event)
{
// Log but take no action.
    printlog("Mouse event\n");
    event.Skip();
// Here I use a mouse event to force a re-draw.
    Refresh();     // forces redraw of everything
}

void showmathPanel::OnPaint(wxPaintEvent &event)
{   printlog("OnPaint called\n");
    wxPaintDC mydc(this);
//    mydc.SetBackground(*wxWHITE_BRUSH);
//@ The fillowing few lines would make sense if the window I was working
//@ with here was a scrolled one... which in the fullness of time it will be!
//@    int vbX, vbY;
//@    GetViewStart(&vbX, &vbY);
//@    printlog("top left of client is at %d %d\n", vbX, vbY);
    wxRegionIterator upd(GetUpdateRegion());
    if (!upd) return; // no update regiions reported!
// Rather than re-painting the whole screen I should cover just the
// regions I have been told to refresh. I will use tileMap to control
// the actual painting.
    for (int i=0; i<64; i++) tileMap[i] = 0;
    while (upd)
    {   int vX = upd.GetX();
        int vY = upd.GetY();
        int vW = vX + upd.GetW();
        int vH = vY + upd.GetH();
// I set a bit in tileMap for each tile that will actually need painting.
        printlog("Need to repaint %d %d %d %d\n", vX, vY, vW, vH);
        for (int y=vY/smallTileSize;
             y<=(vH+smallTileSize-1)/smallTileSize;
             y++)
            for (int x=vX/smallTileSize;
                 x<=(vW+smallTileSize-1)/smallTileSize;
                 x++)
            {
#ifdef SHOW_WHICH_TILES_WILL_BE_REDRAWN
                printlog("tile at %d %d to be redrawn\n",
                         x*smallTileSize, y*smallTileSize);
#endif
                tileMap[y] |= ((uint64_t)1)<<x;
            }
        upd++;
    }
#ifdef DISPLAY_TILE_BITMAP
    for (int y=0; y<64; y++)
    {   uint64_t v = tileMap[y];
        for (int x=0; x<64; x++)
        {   std::putchar('0' + static_cast<int>(v & 1));
            v = v >> 1;
        }
        std::putchar('\n');
    }
#endif
    sw.Start(0);
    int tileCount = 0;
    typedef wxPixelData<wxBitmap, wxNativePixelFormat> PixelData;
    PixelData bigData(*bigBitmap);
    if (!bigData) printlog("Creation of bigData failed\n");
    PixelData smallData(*smallTile);
    if (!smallData) printlog("Creation of smallData failed\n");
    PixelData::Iterator pBig(bigData);
    PixelData::Iterator pSmall(smallData);
    for (int tileY=0; tileY<clientHeight; tileY+=smallTileSize)
        for (int tileX=0; tileX<clientWidth;  tileX+=smallTileSize)
        {   if ((tileMap[tileY/smallTileSize] &
                 (((uint64_t)1)<<(tileX/smallTileSize))) == 0) continue;
            tileCount++;
            pBig.MoveTo(bigData, (bigTileSize*tileX)/smallTileSize,
                        (bigTileSize*tileY)/smallTileSize);
            pSmall.MoveTo(smallData, 0, 0);
            int srcY=0, srcY1=smallTileSize, destY=0, destY1=bigTileSize;
            int srcPixYR[maxSmallTileSize],
                srcPixYG[maxSmallTileSize],
                srcPixYB[maxSmallTileSize],
                destPixYR[maxBigTileSize],
                destPixYG[maxBigTileSize],
                destPixYB[maxBigTileSize];
            int scale = bigTileSize*bigTileSize;
            for (int i=0; i<smallTileSize; i++)
            {   srcPixYR[i] = 0;  srcPixYG[i] = 0;  srcPixYB[i] = 0;
                destPixYR[i] = 0; destPixYG[i] = 0; destPixYB[i] = 0;
            }
            while (destY < smallTileSize)
            {   PixelData::Iterator rowStartSmall = pSmall;
                PixelData::Iterator rowStartBig = pBig;
                int srcX=0, srcX1=smallTileSize, destX=0, destX1=bigTileSize;
                int srcPixXR=0, srcPixXG=0, srcPixXB=0,
                    destPixXR=0, destPixXG=0, destPixXB=0,
                    w;
                while (destX < smallTileSize)
                {
// The next few lines are the only ones where I access the source bitmap...
                    srcPixXR = pBig.Red();
                    srcPixXG = pBig.Green();
                    srcPixXB = pBig.Blue();
                    ++pBig;
                    srcX++;
                    if (srcX1 < destX1)
                    {   destPixXR += smallTileSize*srcPixXR;
                        destPixXG += smallTileSize*srcPixXG;
                        destPixXB += smallTileSize*srcPixXB;
                    }
                    else
                    {   w = srcX1 - destX1;
                        srcPixYR[destX] = (srcPixXR*(smallTileSize-w) + destPixXR);
                        srcPixYG[destX] = (srcPixXG*(smallTileSize-w) + destPixXG);
                        srcPixYB[destX] = (srcPixXB*(smallTileSize-w) + destPixXB);
                        destPixXR = srcPixXR*w;
                        destPixXG = srcPixXG*w;
                        destPixXB = srcPixXB*w;
                        destX++;
                        destX1 += bigTileSize;
                    }
                    srcX1 += smallTileSize;
                }
                pBig = rowStartBig;
                pBig.OffsetY(bigData, 1);
                srcY++;
                if (srcY1 < destY1)
                {   for (int i=0; i<smallTileSize; i++)
                    {   destPixYR[i] += smallTileSize*srcPixYR[i];
                        destPixYG[i] += smallTileSize*srcPixYG[i];
                        destPixYB[i] += smallTileSize*srcPixYB[i];
                    }
                }
                else
                {   w = srcY1 - destY1;
                    for (int i=0; i<smallTileSize; i++)
                    {
// The next few lines are the only ones where I access the destination bitmap...
                        pSmall.Red() =
                            (srcPixYR[i]*(smallTileSize-w) + destPixYR[i])/scale;
                        pSmall.Green() =
                            (srcPixYG[i]*(smallTileSize-w) + destPixYG[i])/scale;
                        pSmall.Blue() =
                            (srcPixYB[i]*(smallTileSize-w) + destPixYB[i])/scale;
                        ++pSmall;
                        destPixYR[i] = srcPixYR[i]*w;
                        destPixYG[i] = srcPixYG[i]*w;
                        destPixYB[i] = srcPixYB[i]*w;
                    }
                    pSmall = rowStartSmall;
                    pSmall.OffsetY(smallData, 1);
                    destY++;
                    destY1 += bigTileSize;
                }
                srcY1 += smallTileSize;
            }
            mydc.DrawBitmap(*smallTile, tileX, tileY);
        }
    printlog("Scale %d tiles from bitmap to screen in %" PRId64 "\n",
             tileCount, (int64_t)sw.Time());


}

// A dummy definition that is needed because of wxfwin.cpp

int windowed_worker(int argc, const char *argv[],
                    fwin_entrypoint *fwin_main)
{   return 0;
}

// end of wxshowmath.cpp