source: git/src/aven.cc @ e840570

Last change on this file since e840570 was e840570, checked in by Olly Betts <olly@…>, 9 months ago

Drop support for wxWidgets < 3.0

3.0.0 was released over 5 years ago and should be easily available
everywhere by now.

I'm no longer easily able to test with wxWidgets 2.8, and this allows
a significant amount of cruft to be removed.

  • Property mode set to 100644
File size: 13.2 KB
Line 
1//
2//  aven.cc
3//
4//  Main class for Aven.
5//
6//  Copyright (C) 2001 Mark R. Shinwell.
7//  Copyright (C) 2002,2003,2004,2005,2006,2011,2013,2014,2015,2016,2017,2018 Olly Betts
8//
9//  This program is free software; you can redistribute it and/or modify
10//  it under the terms of the GNU General Public License as published by
11//  the Free Software Foundation; either version 2 of the License, or
12//  (at your option) any later version.
13//
14//  This program is distributed in the hope that it will be useful,
15//  but WITHOUT ANY WARRANTY; without even the implied warranty of
16//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17//  GNU General Public License for more details.
18//
19//  You should have received a copy of the GNU General Public License
20//  along with this program; if not, write to the Free Software
21//  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
22//
23
24#ifdef HAVE_CONFIG_H
25#include <config.h>
26#endif
27
28#define MSG_SETUP_PROJ_SEARCH_PATH 1
29
30#include "aven.h"
31#include "log.h"
32#include "gla.h"
33#include "mainfrm.h"
34
35#include "cmdline.h"
36#include "message.h"
37#include "useful.h"
38
39#include <assert.h>
40#include <stdio.h>
41
42#include <wx/confbase.h>
43#include <wx/image.h>
44#if wxUSE_DISPLAY
45// wxDisplay was added in wx 2.5; but it may not be built for mingw (because
46// the header seems to be missing).
47#include <wx/display.h>
48#endif
49
50#ifdef __WXMSW__
51#include <windows.h>
52#endif
53
54static const struct option long_opts[] = {
55    /* const char *name; int has_arg (0 no_argument, 1 required_*, 2 optional_*); int *flag; int val; */
56    {"survey", required_argument, 0, 's'},
57    {"print", no_argument, 0, 'p'},
58    {"help", no_argument, 0, HLP_HELP},
59    {"version", no_argument, 0, HLP_VERSION},
60    {0, 0, 0, 0}
61};
62
63#define short_opts "s:p"
64
65static struct help_msg help[] = {
66    /*                          <-- */
67    /* TRANSLATORS: --help output for --survey option.
68     *
69     * "this" has been added to English translation */
70    {HLP_ENCODELONG(0),       /*only load the sub-survey with this prefix*/199, 0},
71    /* TRANSLATORS: --help output for aven --print option */
72    {HLP_ENCODELONG(1),       /*print and exit (requires a 3d file)*/119, 0},
73    {0, 0, 0}
74};
75
76#ifdef __WXMSW__
77IMPLEMENT_APP(Aven)
78#else
79IMPLEMENT_APP_NO_MAIN(Aven)
80IMPLEMENT_WX_THEME_SUPPORT
81#endif
82
83Aven::Aven() :
84    m_Frame(NULL), m_pageSetupData(NULL)
85{
86    wxFont::SetDefaultEncoding(wxFONTENCODING_UTF8);
87}
88
89Aven::~Aven()
90{
91    delete m_pageSetupData;
92}
93
94static int getopt_first_response = 0;
95
96static char ** utf8_argv;
97
98#ifdef __WXMSW__
99bool Aven::Initialize(int& my_argc, wxChar **my_argv)
100{
101    const wxChar * cmd_line = GetCommandLineW();
102
103    // Horrible bodge to handle therion's assumptions about the "Process"
104    // file association.
105    if (cmd_line) {
106        // None of these are valid aven command line options, so this is not
107        // going to be triggered accidentally.
108        const wxChar * p = wxStrstr(cmd_line,
109                                    wxT("aven.exe\" --quiet --log --output="));
110        if (p) {
111            // Just change the command name in the command line string - that
112            // way the quoting should match what the C runtime expects.
113            wxString cmd(cmd_line, p - cmd_line);
114            cmd += "cavern";
115            cmd += p + 4;
116            exit(wxExecute(cmd, wxEXEC_SYNC));
117        }
118    }
119
120    int utf8_argc;
121    {
122        // wxWidgets doesn't split up the command line in the standard way, so
123        // redo it ourselves using the standard API function.
124        //
125        // Warning: The returned array from this has no terminating NULL
126        // element.
127        wxChar ** new_argv = NULL;
128        if (cmd_line)
129            new_argv = CommandLineToArgvW(cmd_line, &utf8_argc);
130        bool failed = (new_argv == NULL);
131        if (failed) {
132            wxChar * p;
133            FormatMessage(
134                    FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
135                    NULL,
136                    GetLastError(),
137                    0,
138                    (LPWSTR)&p,
139                    4096,
140                    NULL);
141            wxString m = "CommandLineToArgvW failed: ";
142            m += p;
143            wxMessageBox(m, APP_NAME, wxOK | wxCENTRE | wxICON_EXCLAMATION);
144            LocalFree(p);
145            utf8_argc = my_argc;
146            new_argv = my_argv;
147        }
148
149        // Convert wide characters to UTF-8.
150        utf8_argv = new char * [utf8_argc + 1];
151        for (int i = 0; i < utf8_argc; ++i){
152            utf8_argv[i] = strdup(wxString(new_argv[i]).utf8_str());
153        }
154        utf8_argv[utf8_argc] = NULL;
155
156        if (!failed) LocalFree(new_argv);
157    }
158
159    msg_init(utf8_argv);
160    select_charset(CHARSET_UTF8);
161    /* Want --version and decent --help output, which cmdline does for us.
162     * wxCmdLine is much less good.
163     */
164    /* TRANSLATORS: Here "survey" is a "cave map" rather than list of questions
165     * - it should be translated to the terminology that cavers using the
166     * language would use.
167     *
168     * Part of aven --help */
169    cmdline_set_syntax_message(/*[SURVEY_FILE]*/269, 0, NULL);
170    cmdline_init(utf8_argc, utf8_argv, short_opts, long_opts, NULL, help, 0, 1);
171    getopt_first_response = cmdline_getopt();
172
173    // The argc and argv arguments don't actually get used here.
174    int dummy_argc = 0;
175    return wxApp::Initialize(dummy_argc, NULL);
176}
177#else
178int main(int argc, char **argv)
179{
180#ifdef __WXGTK3__
181    // Currently wxGLCanvas doesn't work under Wayland, and the code segfaults.
182    // https://trac.wxwidgets.org/ticket/17702
183    // Setting GDK_BACKEND=x11 is the recommended workaround, and it seems to
184    // work to set it here.
185    setenv("GDK_BACKEND", "x11", 1);
186#endif
187#ifdef __WXMAC__
188    // MacOS passes a magic -psn_XXXX command line argument in argv[1] which
189    // wx ignores for us, but in wxApp::Initialize() which hasn't been
190    // called yet.  So we need to remove it ourselves.
191    if (argc > 1 && strncmp(argv[1], "-psn_", 5) == 0) {
192        --argc;
193        memmove(argv + 1, argv + 2, argc * sizeof(char *));
194    }
195#endif
196    // Call msg_init() and start processing the command line first so that
197    // we can respond to --help and --version even without an X display.
198    msg_init(argv);
199    select_charset(CHARSET_UTF8);
200    /* Want --version and decent --help output, which cmdline does for us.
201     * wxCmdLine is much less good.
202     */
203    cmdline_set_syntax_message(/*[SURVEY_FILE]*/269, 0, NULL);
204    cmdline_init(argc, argv, short_opts, long_opts, NULL, help, 0, 1);
205    getopt_first_response = cmdline_getopt();
206
207    utf8_argv = argv;
208
209#if wxUSE_UNICODE
210    wxWCharBuffer buf(wxConvFileName->cMB2WX(argv[0]));
211    wxChar * wargv[2];
212    if (buf) {
213        wargv[0] = wxStrdup(buf);
214    } else {
215        // Eep - couldn't convert the executable's name to wide characters!
216        wargv[0] = wxStrdup(APP_NAME);
217    }
218    wargv[1] = NULL;
219    int wargc = 1;
220    return wxEntry(wargc, wargv);
221#else
222    char *dummy_argv[2] = { argv[0], NULL };
223    int dummy_argc = 1;
224    return wxEntry(dummy_argc, dummy_argv);
225#endif
226}
227#endif
228
229bool Aven::OnInit()
230{
231    wxLog::SetActiveTarget(new MyLogWindow());
232
233    {
234        // Suppress message box warnings about messages not found.
235        wxLogNull logNo;
236        wxLocale *loc = new wxLocale();
237        loc->AddCatalogLookupPathPrefix(wmsg_cfgpth());
238        wxString msg_lang_str(msg_lang, wxConvUTF8);
239        const char *lang = msg_lang2 ? msg_lang2 : msg_lang;
240        wxString lang_str(lang, wxConvUTF8);
241        loc->Init(msg_lang_str, lang_str, msg_lang_str);
242        // The existence of the wxLocale object is enough - no need to keep a
243        // pointer to it!
244    }
245
246    const char* opt_survey = NULL;
247    bool print_and_exit = false;
248
249    while (true) {
250        int opt;
251        if (getopt_first_response) {
252            opt = getopt_first_response;
253            getopt_first_response = 0;
254        } else {
255            opt = cmdline_getopt();
256        }
257        if (opt == EOF) break;
258        if (opt == 's') {
259            if (opt_survey != NULL) {
260                // FIXME: Not a helpful error, but this is temporary until
261                // we actually hook up support for specifying multiple
262                // --survey options properly here.
263                cmdline_syntax();
264                exit(1);
265            }
266            opt_survey = optarg;
267        }
268        if (opt == 'p') {
269            print_and_exit = true;
270        }
271    }
272
273    if (print_and_exit && !utf8_argv[optind]) {
274        cmdline_syntax(); // FIXME : not a helpful error...
275        exit(1);
276    }
277
278    wxString fnm;
279    if (utf8_argv[optind]) {
280        fnm = wxString(utf8_argv[optind], wxConvUTF8);
281        if (fnm.empty() && *(utf8_argv[optind])) {
282            ReportError(wxT("File argument's filename has bad encoding"));
283            return false;
284        }
285    }
286
287    if (!GLACanvas::check_visual()) {
288        wxString m;
289        /* TRANSLATORS: %s will be replaced with "Aven" currently (and
290         * perhaps by "Survex" or other things in future). */
291        m.Printf(wmsg(/*This version of %s requires OpenGL to work, but it isn’t available.*/405), APP_NAME);
292        wxMessageBox(m, APP_NAME, wxOK | wxCENTRE | wxICON_EXCLAMATION);
293        exit(1);
294    }
295
296    wxImage::AddHandler(new wxPNGHandler);
297
298    // Obtain the screen geometry.
299#if wxUSE_DISPLAY
300    wxRect geom = wxDisplay().GetGeometry();
301#else
302    wxRect geom;
303    wxClientDisplayRect(&geom.x, &geom.y, &geom.width, &geom.height);
304#endif
305
306    wxPoint pos(wxDefaultPosition);
307    int width, height;
308    wxConfigBase::Get()->Read(wxT("width"), &width, 0);
309    if (width > 0) wxConfigBase::Get()->Read(wxT("height"), &height, 0);
310    // We used to persist full screen mode (-1 was maximized,
311    // -2 full screen), but people would get stuck in full
312    // screen mode, unsure how to exit.
313    bool maximized = (width <= -1);
314    if (width <= 0 || height <= 0) {
315        pos.x = geom.x;
316        pos.y = geom.y;
317        width = geom.width;
318        height = geom.height;
319
320        // Calculate a reasonable size for our window.
321        pos.x += width / 8;
322        pos.y += height / 8;
323        width = width * 3 / 4;
324        height = height * 3 / 4;
325    } else {
326        // Impose a minimum size for sanity, and make sure the window fits on
327        // the display (in case the current display is smaller than the one
328        // in use when the window size was saved).  (480x320) is about the
329        // smallest usable size for aven's window.
330        const int min_width = min(geom.width, 480);
331        const int min_height = min(geom.height, 320);
332        if (width < min_width || height < min_height) {
333            if (width < min_width) {
334                width = min_width;
335            }
336            if (height < min_height) {
337                height = min_height;
338            }
339            pos.x = geom.x + (geom.width - width) / 4;
340            pos.y = geom.y + (geom.height - height) / 4;
341        }
342    }
343
344    // Create the main window.
345    m_Frame = new MainFrm(APP_NAME, pos, wxSize(width, height));
346
347    // Select maximised if that's the saved state.
348    if (maximized) {
349        m_Frame->Maximize();
350    }
351
352    if (utf8_argv[optind]) {
353        if (!opt_survey) opt_survey = "";
354        m_Frame->OpenFile(fnm, wxString(opt_survey, wxConvUTF8));
355    }
356
357    if (print_and_exit) {
358        m_Frame->PrintAndExit();
359        return true;
360    }
361
362    m_Frame->Show(true);
363#ifdef _WIN32
364    m_Frame->SetFocus();
365#endif
366    return true;
367}
368
369wxPageSetupDialogData *
370Aven::GetPageSetupDialogData()
371{
372    if (!m_pageSetupData) m_pageSetupData = new wxPageSetupDialogData;
373#ifdef __WXGTK__
374    // Fetch paper margins stored on disk.
375    int left, right, top, bottom;
376    wxConfigBase * cfg = wxConfigBase::Get();
377    // These default margins were chosen by looking at all the .ppd files
378    // on my machine.
379    cfg->Read(wxT("paper_margin_left"), &left, 7);
380    cfg->Read(wxT("paper_margin_right"), &right, 7);
381    cfg->Read(wxT("paper_margin_top"), &top, 14);
382    cfg->Read(wxT("paper_margin_bottom"), &bottom, 14);
383    m_pageSetupData->SetMarginTopLeft(wxPoint(left, top));
384    m_pageSetupData->SetMarginBottomRight(wxPoint(right, bottom));
385#endif
386    return m_pageSetupData;
387}
388
389void
390Aven::SetPageSetupDialogData(const wxPageSetupDialogData & psdd)
391{
392    if (!m_pageSetupData) m_pageSetupData = new wxPageSetupDialogData;
393    *m_pageSetupData = psdd;
394#ifdef __WXGTK__
395    wxPoint topleft = psdd.GetMarginTopLeft();
396    wxPoint bottomright = psdd.GetMarginBottomRight();
397
398    // Store user specified paper margins on disk/in registry.
399    wxConfigBase * cfg = wxConfigBase::Get();
400    cfg->Write(wxT("paper_margin_left"), topleft.x);
401    cfg->Write(wxT("paper_margin_right"), bottomright.x);
402    cfg->Write(wxT("paper_margin_top"), topleft.y);
403    cfg->Write(wxT("paper_margin_bottom"), bottomright.y);
404    cfg->Flush();
405#endif
406}
407
408#ifdef __WXMAC__
409void
410Aven::MacOpenFiles(const wxArrayString & filenames)
411{
412    if (filenames.size() != 1) {
413        ReportError(wxT("Aven can only load one file at a time"));
414        return;
415    }
416    m_Frame->OpenFile(filenames[0], wxString());
417}
418
419void
420Aven::MacPrintFiles(const wxArrayString & filenames)
421{
422    if (filenames.size() != 1) {
423        ReportError(wxT("Aven can only print one file at a time"));
424        return;
425    }
426    m_Frame->OpenFile(filenames[0], wxString());
427    m_Frame->PrintAndExit();
428}
429#endif
430
431void Aven::ReportError(const wxString& msg)
432{
433    if (!m_Frame) {
434        wxMessageBox(msg, APP_NAME, wxOK | wxICON_ERROR);
435        return;
436    }
437    wxMessageDialog dlg(m_Frame, msg, APP_NAME, wxOK | wxICON_ERROR);
438    dlg.ShowModal();
439}
440
441const wxString &
442wmsg_cfgpth()
443{
444    static wxString path;
445    if (path.empty())
446        path = wxString(msg_cfgpth(), wxConvUTF8);
447    return path;
448}
449
450// called to report errors by message.c
451extern "C" void
452aven_v_report(int severity, const char *fnm, int line, int en, va_list ap)
453{
454    wxString m;
455    if (fnm) {
456        m = wxString(fnm, wxConvUTF8);
457        if (line) m += wxString::Format(wxT(":%d"), line);
458        m += wxT(": ");
459    }
460
461    if (severity == 0) {
462        m += wmsg(/*warning*/4);
463        m += wxT(": ");
464    }
465
466    char buf[1024];
467    vsnprintf(buf, sizeof(buf), msg(en), ap);
468    m += wxString(buf, wxConvUTF8);
469    if (wxTheApp == NULL) {
470        // We haven't initialised the Aven app object yet.
471        if (!wxInitialize()) {
472            fputs(buf, stderr);
473            PUTC('\n', stderr);
474            exit(1);
475        }
476        wxMessageBox(m, APP_NAME, wxOK | wxICON_ERROR);
477        wxUninitialize();
478    } else {
479        wxGetApp().ReportError(m);
480    }
481}
Note: See TracBrowser for help on using the repository browser.