src/GUI/gui_funcs.cxx

   1 /**************************************************************************
   2  * gui_funcs.cxx
   3  *
   4  * Based on gui.cxx and renamed on 2002/08/13 by Erik Hofman.
   5  *
   6  * Written 1998 by Durk Talsma, started Juni, 1998.  For the flight gear
   7  * project.
   8  *
   9  * Additional mouse supported added by David Megginson, 1999.
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License as
  13  * published by the Free Software Foundation; either version 2 of the
  14  * License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  24  *
  25  * $Id$
  26  **************************************************************************/
  27
  28
  29 #ifdef HAVE_CONFIG_H
  30 #  include <config.h>
  31 #endif
  32
  33 #ifdef HAVE_WINDOWS_H
  34 #include <windows.h>
  35 #endif
  36
  37 #include <simgear/compiler.h>
  38
  39 #include <fstream>
  40 #include <string>
  41 #include <cstring>
  42 #include <sstream>
  43
  44 #include <stdlib.h>
  45
  46 #include <simgear/debug/logstream.hxx>
  47 #include <simgear/misc/sg_path.hxx>
  48 #include <simgear/screen/screen-dump.hxx>
  49 #include <simgear/structure/event_mgr.hxx>
  50 #include <simgear/props/props_io.hxx>
  51
  52 #include <Cockpit/panel.hxx>
  53 #include <Main/globals.hxx>
  54 #include <Main/fg_props.hxx>
  55 #include <Main/fg_os.hxx>
  56 #include <Viewer/renderer.hxx>
  57 #include <Viewer/viewmgr.hxx>
  58 #include <Viewer/WindowSystemAdapter.hxx>
  59 #include <Viewer/CameraGroup.hxx>
  60 #include <GUI/new_gui.hxx>
  61
  62
  63 #ifdef _WIN32
  64 #  include <shellapi.h>
  65 #endif
  66
  67 #if defined(SG_MAC)
  68 # include <GUI/CocoaHelpers.h> // for cocoaOpenUrl
  69 #endif
  70
  71 #include "gui.h"
  72
  73 using std::string;
  74
  75
  76 #if defined( TR_HIRES_SNAP)
  77 #include <simgear/screen/tr.h>
  78 extern void fgUpdateHUD( GLfloat x_start, GLfloat y_start,
  79                          GLfloat x_end, GLfloat y_end );
  80 #endif
  81
  82
  83 const __fg_gui_fn_t __fg_gui_fn[] = {
  84 #ifdef TR_HIRES_SNAP
  85         {"dumpHiResSnapShot", fgHiResDumpWrapper},
  86 #endif
  87         {"dumpSnapShot", fgDumpSnapShotWrapper},
  88         // Help
  89         {"helpCb", helpCb},
  90
  91         // Structure termination
  92         {"", NULL}
  93 };
  94
  95
  96 /* ================ General Purpose Functions ================ */
  97
  98 // General Purpose Message Box. Makes sure no more than 5 different
  99 // messages are displayed at the same time, and none of them are
 100 // duplicates. (5 is a *lot*, but this will hardly ever be reached
 101 // and we don't want to miss any, either.)
 102 void mkDialog (const char *txt)
 103 {
 104     NewGUI *gui = (NewGUI *)globals->get_subsystem("gui");
 105     if (!gui)
 106         return;
 107     SGPropertyNode *master = gui->getDialogProperties("message");
 108     if (!master)
 109         return;
 110
 111     const int maxdialogs = 5;
 112     string name;
 113     SGPropertyNode *msg = fgGetNode("/sim/gui/dialogs", true);
 114     int i;
 115     for (i = 0; i < maxdialogs; i++) {
 116         std::ostringstream s;
 117         s << "message-" << i;
 118         name = s.str();
 119
 120         if (!msg->getNode(name.c_str(), false))
 121             break;
 122
 123         if (!strcmp(txt, msg->getNode(name.c_str())->getStringValue("message"))) {
 124             SG_LOG(SG_GENERAL, SG_WARN, "mkDialog(): duplicate of message " << txt);
 125             return;
 126         }
 127     }
 128     if (i == maxdialogs)
 129         return;
 130     msg = msg->getNode(name.c_str(), true);
 131     msg->setStringValue("message", txt);
 132     msg = msg->getNode("dialog", true);
 133     copyProperties(master, msg);
 134     msg->setStringValue("name", name.c_str());
 135     gui->newDialog(msg);
 136     gui->showDialog(name.c_str());
 137 }
 138
 139 // Message Box to report an error.
 140 void guiErrorMessage (const char *txt)
 141 {
 142     SG_LOG(SG_GENERAL, SG_ALERT, txt);
 143     mkDialog(txt);
 144 }
 145
 146 // Message Box to report a throwable (usually an exception).
 147 void guiErrorMessage (const char *txt, const sg_throwable &throwable)
 148 {
 149     string msg = txt;
 150     msg += '\n';
 151     msg += throwable.getFormattedMessage();
 152     if (std::strlen(throwable.getOrigin()) != 0) {
 153         msg += "\n (reported by ";
 154         msg += throwable.getOrigin();
 155         msg += ')';
 156     }
 157     SG_LOG(SG_GENERAL, SG_ALERT, msg);
 158     mkDialog(msg.c_str());
 159 }
 160
 161
 162
 163 /* -----------------------------------------------------------------------
 164 the Gui callback functions
 165 ____________________________________________________________________*/
 166
 167 void helpCb()
 168 {
 169     openBrowser( "Docs/index.html" );
 170 }
 171
 172 bool openBrowser(const std::string& aAddress)
 173 {
 174     bool ok = true;
 175     string address(aAddress);
 176
 177     // do not resolve addresses with given protocol, i.e. "http://...", "ftp://..."
 178     if (address.find("://")==string::npos)
 179     {
 180         // resolve local file path
 181         SGPath path(address);
 182         path = globals->resolve_maybe_aircraft_path(address);
 183         if (!path.isNull())
 184             address = path.str();
 185         else
 186         {
 187             mkDialog ("Sorry, file not found!");
 188             SG_LOG(SG_GENERAL, SG_ALERT, "openBrowser: Cannot find requested file '"
 189                     << address << "'.");
 190             return false;
 191         }
 192     }
 193
 194 #ifdef SG_MAC
 195   if (address.find("://")==string::npos) {
 196     address = "file://" + address;
 197   }
 198
 199   cocoaOpenUrl(address);
 200 #elif defined _WIN32
 201
 202     // Look for favorite browser
 203     char win32_name[1024];
 204 # ifdef __CYGWIN__
 205     cygwin32_conv_to_full_win32_path(address.c_str(),win32_name);
 206 # else
 207     strncpy(win32_name,address.c_str(), 1024);
 208 # endif
 209     ShellExecute ( NULL, "open", win32_name, NULL, NULL,
 210                    SW_SHOWNORMAL ) ;
 211 #else
 212     // Linux, BSD, SGI etc
 213     string command = globals->get_browser();
 214     string::size_type pos;
 215     if ((pos = command.find("%u", 0)) != string::npos)
 216         command.replace(pos, 2, address);
 217     else
 218         command += " \"" + address +"\"";
 219
 220     command += " &";
 221     ok = (system( command.c_str() ) == 0);
 222 #endif
 223
 224     if( fgGetBool("/sim/gui/show-browser-open-hint", true) )
 225         mkDialog("The file is shown in your web browser window.");
 226
 227     return ok;
 228 }
 229
 230 #if defined( TR_HIRES_SNAP)
 231 void fgHiResDump()
 232 {
 233     FILE *f;
 234     string message;
 235     bool menu_status = fgGetBool("/sim/menubar/visibility");
 236     char *filename = new char [24];
 237     static int count = 1;
 238
 239     SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
 240
 241     bool freeze = master_freeze->getBoolValue();
 242     if ( !freeze ) {
 243         master_freeze->setBoolValue(true);
 244     }
 245
 246     fgSetBool("/sim/menubar/visibility", false);
 247     int mouse = fgGetMouseCursor();
 248     fgSetMouseCursor(MOUSE_CURSOR_NONE);
 249
 250     FGRenderer *renderer = globals->get_renderer();
 251 //     renderer->init();
 252     renderer->resize( fgGetInt("/sim/startup/xsize"),
 253                       fgGetInt("/sim/startup/ysize") );
 254
 255     // we need two render frames here to clear the menu and cursor
 256     // ... not sure why but doing an extra fgRenderFrame() shouldn't
 257     // hurt anything
 258     //renderer->update( true );
 259     //renderer->update( true );
 260
 261     // This ImageSize stuff is a temporary hack
 262     // should probably use 128x128 tile size and
 263     // support any image size
 264
 265     // This should be a requester to get multiplier from user
 266     int multiplier = fgGetInt("/sim/startup/hires-multiplier", 3);
 267     int width = fgGetInt("/sim/startup/xsize");
 268     int height = fgGetInt("/sim/startup/ysize");
 269
 270     /* allocate buffer large enough to store one tile */
 271     GLubyte *tile = (GLubyte *)malloc(width * height * 3 * sizeof(GLubyte));
 272     if (!tile) {
 273         delete [] filename;
 274         printf("Malloc of tile buffer failed!\n");
 275         return;
 276     }
 277
 278     int imageWidth  = multiplier*width;
 279     int imageHeight = multiplier*height;
 280
 281     /* allocate buffer to hold a row of tiles */
 282     GLubyte *buffer
 283         = (GLubyte *)malloc(imageWidth * height * 3 * sizeof(GLubyte));
 284     if (!buffer) {
 285         delete [] filename;
 286         free(tile);
 287         printf("Malloc of tile row buffer failed!\n");
 288         return;
 289     }
 290     TRcontext *tr = trNew();
 291     trTileSize(tr, width, height, 0);
 292     trTileBuffer(tr, GL_RGB, GL_UNSIGNED_BYTE, tile);
 293     trImageSize(tr, imageWidth, imageHeight);
 294     trRowOrder(tr, TR_TOP_TO_BOTTOM);
 295     // OSGFIXME
 296 //     sgFrustum *frustum = ssgGetFrustum();
 297 //     trFrustum(tr,
 298 //               frustum->getLeft(), frustum->getRight(),
 299 //               frustum->getBot(),  frustum->getTop(),
 300 //               frustum->getNear(), frustum->getFar());
 301
 302     /* Prepare ppm output file */
 303     while (count < 1000) {
 304         snprintf(filename, 24, "fgfs-screen-%03d.ppm", count++);
 305         if ( (f = fopen(filename, "r")) == NULL )
 306             break;
 307         fclose(f);
 308     }
 309     f = fopen(filename, "wb");
 310     if (!f) {
 311         printf("Couldn't open image file: %s\n", filename);
 312         delete [] filename;
 313         free(buffer);
 314         free(tile);
 315         return;
 316     }
 317     fprintf(f,"P6\n");
 318     fprintf(f,"# ppm-file created by %s\n", "trdemo2");
 319     fprintf(f,"%i %i\n", imageWidth, imageHeight);
 320     fprintf(f,"255\n");
 321
 322     /* just to be safe... */
 323     glPixelStorei(GL_PACK_ALIGNMENT, 1);
 324
 325     // OSGFIXME
 326 #if 0
 327     /* Because the HUD and Panel change the ViewPort we will
 328      * need to handle some lowlevel stuff ourselves */
 329     int ncols = trGet(tr, TR_COLUMNS);
 330     int nrows = trGet(tr, TR_ROWS);
 331
 332     bool do_hud = fgGetBool("/sim/hud/visibility");
 333     GLfloat hud_col_step = 640.0 / ncols;
 334     GLfloat hud_row_step = 480.0 / nrows;
 335
 336     bool do_panel = fgPanelVisible();
 337     GLfloat panel_col_step = globals->get_current_panel()->getWidth() / ncols;
 338     GLfloat panel_row_step = globals->get_current_panel()->getHeight() / nrows;
 339 #endif
 340     glHint(GL_PERSPECTIVE_CORRECTION_HINT, GL_NICEST);
 341     glHint(GL_POLYGON_SMOOTH_HINT, GL_NICEST);
 342     glHint(GL_LINE_SMOOTH_HINT, GL_NICEST);
 343     glHint(GL_POINT_SMOOTH_HINT, GL_NICEST);
 344     glHint(GL_FOG_HINT, GL_NICEST);
 345
 346     /* Draw tiles */
 347     int more = 1;
 348     while (more) {
 349         trBeginTile(tr);
 350         int curColumn = trGet(tr, TR_CURRENT_COLUMN);
 351         // int curRow =  trGet(tr, TR_CURRENT_ROW);
 352
 353         renderer->update();
 354         // OSGFIXME
 355 //         if ( do_hud )
 356 //             fgUpdateHUD( curColumn*hud_col_step,      curRow*hud_row_step,
 357 //                          (curColumn+1)*hud_col_step, (curRow+1)*hud_row_step );
 358         // OSGFIXME
 359 //         if (do_panel)
 360 //             globals->get_current_panel()->update(
 361 //                                    curColumn*panel_col_step, panel_col_step,
 362 //                                    curRow*panel_row_step,    panel_row_step );
 363         more = trEndTile(tr);
 364
 365         /* save tile into tile row buffer*/
 366         int curTileWidth = trGet(tr, TR_CURRENT_TILE_WIDTH);
 367         int bytesPerImageRow = imageWidth * 3*sizeof(GLubyte);
 368         int bytesPerTileRow = (width) * 3*sizeof(GLubyte);
 369         int xOffset = curColumn * bytesPerTileRow;
 370         int bytesPerCurrentTileRow = (curTileWidth) * 3*sizeof(GLubyte);
 371         int i;
 372         for (i=0;i<height;i++) {
 373             memcpy(buffer + i*bytesPerImageRow + xOffset, /* Dest */
 374                    tile + i*bytesPerTileRow,              /* Src */
 375                    bytesPerCurrentTileRow);               /* Byte count*/
 376         }
 377
 378         if (curColumn == trGet(tr, TR_COLUMNS)-1) {
 379             /* write this buffered row of tiles to the file */
 380             int curTileHeight = trGet(tr, TR_CURRENT_TILE_HEIGHT);
 381             int bytesPerImageRow = imageWidth * 3*sizeof(GLubyte);
 382             int i;
 383             for (i=0;i<curTileHeight;i++) {
 384                 /* Remember, OpenGL images are bottom to top.  Have to reverse. */
 385                 GLubyte *rowPtr = buffer + (curTileHeight-1-i) * bytesPerImageRow;
 386                 fwrite(rowPtr, 1, imageWidth*3, f);
 387             }
 388         }
 389
 390     }
 391
 392     renderer->resize( width, height );
 393
 394     trDelete(tr);
 395
 396     glHint(GL_POLYGON_SMOOTH_HINT, GL_DONT_CARE);
 397     glHint(GL_LINE_SMOOTH_HINT, GL_DONT_CARE);
 398     glHint(GL_POINT_SMOOTH_HINT, GL_DONT_CARE);
 399     glHint(GL_PERSPECTIVE_CORRECTION_HINT, GL_DONT_CARE);
 400     if ( (!strcmp(fgGetString("/sim/rendering/fog"), "disabled")) ||
 401          (!fgGetBool("/sim/rendering/shading"))) {
 402         // if fastest fog requested, or if flat shading force fastest
 403         glHint ( GL_FOG_HINT, GL_FASTEST );
 404     } else if ( !strcmp(fgGetString("/sim/rendering/fog"), "nicest") ) {
 405         glHint ( GL_FOG_HINT, GL_DONT_CARE );
 406     }
 407
 408     fclose(f);
 409
 410     message = "Snapshot saved to \"";
 411     message += filename;
 412     message += "\".";
 413     mkDialog (message.c_str());
 414
 415     free(tile);
 416     free(buffer);
 417
 418     delete [] filename;
 419
 420     fgSetMouseCursor(mouse);
 421     fgSetBool("/sim/menubar/visibility", menu_status);
 422
 423     if ( !freeze ) {
 424         master_freeze->setBoolValue(false);
 425     }
 426 }
 427 #endif // #if defined( TR_HIRES_SNAP)
 428
 429 void fgDumpSnapShotWrapper () {
 430     fgDumpSnapShot();
 431 }
 432
 433
 434 void fgHiResDumpWrapper () {
 435     fgHiResDump();
 436 }
 437
 438 namespace
 439 {
 440     using namespace flightgear;
 441
 442     SGPath nextScreenshotPath(const std::string& screenshotDir)
 443     {
 444         char filename[32];
 445         static int count = 1;
 446         while (count < 1000) {
 447             snprintf(filename, 32, "fgfs-screen-%03d.png", count++);
 448
 449             SGPath p(screenshotDir);
 450             p.append(filename);
 451             if (!p.exists()) {
 452                 return p;
 453             }
 454         }
 455
 456         return SGPath();
 457     }
 458
 459     class GUISnapShotOperation :
 460         public GraphicsContextOperation
 461     {
 462     public:
 463
 464         // start new snap shot
 465         static bool start()
 466         {
 467             // allow only one snapshot at a time
 468             if (_snapShotOp.valid())
 469                 return false;
 470             _snapShotOp = new GUISnapShotOperation();
 471             /* register with graphics context so actual snap shot is done
 472              * in the graphics context (thread) */
 473             osg::Camera* guiCamera = getGUICamera(CameraGroup::getDefault());
 474             WindowSystemAdapter* wsa = WindowSystemAdapter::getWSA();
 475             osg::GraphicsContext* gc = 0;
 476             if (guiCamera)
 477                 gc = guiCamera->getGraphicsContext();
 478             if (gc) {
 479                 gc->add(_snapShotOp.get());
 480             } else {
 481                 wsa->windows[0]->gc->add(_snapShotOp.get());
 482             }
 483             return true;
 484         }
 485
 486     private:
 487         // constructor to be executed in main loop's thread
 488         GUISnapShotOperation() :
 489             flightgear::GraphicsContextOperation(std::string("GUI snap shot")),
 490             _master_freeze(fgGetNode("/sim/freeze/master", true)),
 491             _freeze(_master_freeze->getBoolValue()),
 492             _result(false),
 493             _mouse(fgGetMouseCursor())
 494         {
 495             if (!_freeze)
 496                 _master_freeze->setBoolValue(true);
 497
 498             fgSetMouseCursor(MOUSE_CURSOR_NONE);
 499
 500             string dir = fgGetString("/sim/paths/screenshot-dir");
 501             if (dir.empty())
 502                 dir = SGPath::desktop().str();
 503
 504             _path.set(dir + '/');
 505             if (_path.create_dir( 0755 )) {
 506                 SG_LOG(SG_GENERAL, SG_ALERT, "Cannot create screenshot directory '"
 507                         << dir << "'. Trying home directory.");
 508                 dir = globals->get_fg_home();
 509             }
 510
 511             _path = nextScreenshotPath(dir);
 512             _xsize = fgGetInt("/sim/startup/xsize");
 513             _ysize = fgGetInt("/sim/startup/ysize");
 514
 515             FGRenderer *renderer = globals->get_renderer();
 516             renderer->resize(_xsize, _ysize);
 517             globals->get_event_mgr()->addTask("SnapShotTimer",
 518                     this, &GUISnapShotOperation::timerExpired,
 519                     0.1, false);
 520         }
 521
 522         // to be executed in graphics context (maybe separate thread)
 523         void run(osg::GraphicsContext* gc)
 524         {
 525             _result = sg_glDumpWindow(_path.c_str(),
 526                                      _xsize,
 527                                      _ysize);
 528         }
 529
 530         // timer method, to be executed in main loop's thread
 531         virtual void timerExpired()
 532         {
 533             if (isFinished())
 534             {
 535                 globals->get_event_mgr()->removeTask("SnapShotTimer");
 536
 537                 fgSetString("/sim/paths/screenshot-last", _path.c_str());
 538                 fgSetBool("/sim/signals/screenshot", _result);
 539
 540                 fgSetMouseCursor(_mouse);
 541
 542                 if ( !_freeze )
 543                     _master_freeze->setBoolValue(false);
 544
 545                 _snapShotOp = 0;
 546             }
 547         }
 548
 549         static osg::ref_ptr<GUISnapShotOperation> _snapShotOp;
 550         SGPropertyNode_ptr _master_freeze;
 551         bool _freeze;
 552         bool _result;
 553         int _mouse;
 554         int _xsize, _ysize;
 555         SGPath _path;
 556     };
 557
 558 } // of anonymous namespace
 559
 560 osg::ref_ptr<GUISnapShotOperation> GUISnapShotOperation::_snapShotOp;
 561
 562 // do a screen snap shot
 563 bool fgDumpSnapShot ()
 564 {
 565     // start snap shot operation, while needs to be executed in
 566     // graphics context
 567     return GUISnapShotOperation::start();
 568 }
 569
 570 // do an entire scenegraph dump
 571 void fgDumpSceneGraph()
 572 {
 573     char *filename = new char [24];
 574     string message;
 575     static int count = 1;
 576
 577     SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
 578
 579     bool freeze = master_freeze->getBoolValue();
 580     if ( !freeze ) {
 581         master_freeze->setBoolValue(true);
 582     }
 583
 584     while (count < 1000) {
 585         FILE *fp;
 586         snprintf(filename, 24, "fgfs-graph-%03d.osg", count++);
 587         if ( (fp = fopen(filename, "r")) == NULL )
 588             break;
 589         fclose(fp);
 590     }
 591
 592     if ( fgDumpSceneGraphToFile(filename)) {
 593         message = "Entire scene graph saved to \"";
 594         message += filename;
 595         message += "\".";
 596     } else {
 597         message = "Failed to save to \"";
 598         message += filename;
 599         message += "\".";
 600     }
 601
 602     mkDialog (message.c_str());
 603
 604     delete [] filename;
 605
 606     if ( !freeze ) {
 607         master_freeze->setBoolValue(false);
 608     }
 609 }
 610
 611
 612 // do an terrain branch dump
 613 void fgDumpTerrainBranch()
 614 {
 615     char *filename = new char [24];
 616     string message;
 617     static int count = 1;
 618
 619     SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
 620
 621     bool freeze = master_freeze->getBoolValue();
 622     if ( !freeze ) {
 623         master_freeze->setBoolValue(true);
 624     }
 625
 626     while (count < 1000) {
 627         FILE *fp;
 628         snprintf(filename, 24, "fgfs-graph-%03d.osg", count++);
 629         if ( (fp = fopen(filename, "r")) == NULL )
 630             break;
 631         fclose(fp);
 632     }
 633
 634     if ( fgDumpTerrainBranchToFile(filename)) {
 635         message = "Terrain graph saved to \"";
 636         message += filename;
 637         message += "\".";
 638     } else {
 639         message = "Failed to save to \"";
 640         message += filename;
 641         message += "\".";
 642     }
 643
 644     mkDialog (message.c_str());
 645
 646     delete [] filename;
 647
 648     if ( !freeze ) {
 649         master_freeze->setBoolValue(false);
 650     }
 651 }
 652
 653 void fgPrintVisibleSceneInfoCommand()
 654 {
 655     SGPropertyNode *master_freeze = fgGetNode("/sim/freeze/master");
 656
 657     bool freeze = master_freeze->getBoolValue();
 658     if ( !freeze ) {
 659         master_freeze->setBoolValue(true);
 660     }
 661
 662     flightgear::printVisibleSceneInfo(globals->get_renderer());
 663
 664     if ( !freeze ) {
 665         master_freeze->setBoolValue(false);
 666     }
 667 }