1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
|
/* -*- mode: C++; tab-width: 4 -*- */
/* ================================================================================== */
/* Copyright (c) 1998-1999 3Com Corporation or its subsidiaries. All rights reserved. */
/* ================================================================================== */
#include "EmulatorCommon.h"
#include "Startup.h"
#include "Byteswapping.h" // Canonical
#include "Hordes.h" // Hordes::New
#include "Miscellaneous.h" // IsExecutable
#include "Platform.h" // ForceStartupScreen, QueryNewDocument
#include "PreferenceMgr.h" // Preference
#include "Strings.r.h" // kStr_Autoload, etc.
#include <algorithm> // find()
#include <string>
#include <vector>
// Startup actions.
//static Bool gAskWhatToDo;
static Bool gCreateSession;
static Bool gOpenSession;
// Post-startup actions.
static Bool gStartNewHorde;
// Quit actions.
static Bool gClose;
static Bool gQuitOnExit;
static Bool gQuit;
// Action-specific data.
static Configuration gCfg; // For CreateSession.
static FileReference gSessionOpenRef; // For OpenSession.
static HordeInfo gHorde; // For StartNewGremlin
static StringList gHordeApps; // For StartNewGremlin
static FileReference gSessionCloseRef; // For CloseSession
// These are the files listed on the command line.
static string gAutoRunApp;
static FileRefList gAutoLoadFiles1;
//static FileRefList gAutoRunFiles1;
//static FileRefList gAutoRunAndQuitFiles1;
// These are the files found in the Auto* directories.
static FileRefList gAutoLoadFiles2;
static FileRefList gAutoRunFiles2;
static FileRefList gAutoRunAndQuitFiles2;
// These are the keys we use when tracking what the user has specified.
static const char kOptPSF[] = "psf";
static const char kOptROM[] = "rom";
static const char kOptRAM[] = "ram";
static const char kOptDevice[] = "device";
static const char kOptSkin[] = "skin";
static const char kOptLoad[] = "load";
static const char kOptRun[] = "run";
static const char kOptQuitOnExit[] = "quit_on_exit";
static const char kOptLog[] = "log_dir";
static const char kOptHordeFirst[] = "horde_first";
static const char kOptHordeLast[] = "horde_last";
static const char kOptHordeApps[] = "horde_apps";
static const char kOptHordeSaveDir[] = "horde_save_dir";
static const char kOptHordeSaveFreq[] = "horde_save_freq";
static const char kOptHordeDepthMax[] = "horde_depth_max";
static const char kOptHordeDepthSwitch[] = "horde_depth_switch";
// These are the options the user can specify on the command line.
static const struct
{
const char* option;
const char* optKey;
int optType; // 0 == no parameter, 1 = has parameter
}
kOptionMap [] =
{
{ "-psf", kOptPSF, 1 },
{ "-rom", kOptROM, 1 },
{ "-ram", kOptRAM, 1 },
{ "-ram_size", kOptRAM, 1 },
{ "-device", kOptDevice, 1 },
{ "-skin", kOptSkin, 1 },
{ "-silkscreen", kOptSkin, 1 },
{ "-load_apps", kOptLoad, 1 },
{ "-run_app", kOptRun, 1 },
{ "-quit_on_exit", kOptQuitOnExit, 0 },
{ "-log_save_dir", kOptLog, 1 },
{ "-horde", kOptHordeFirst, 1 },
{ "-horde_first", kOptHordeFirst, 1 },
{ "-horde_last", kOptHordeLast, 1 },
{ "-horde_apps", kOptHordeApps, 1 },
{ "-horde_save_dir", kOptHordeSaveDir, 1 },
{ "-horde_save_freq", kOptHordeSaveFreq, 1 },
{ "-horde_depth_max", kOptHordeDepthMax, 1 },
{ "-horde_depth_switch", kOptHordeDepthSwitch, 1 }
};
// The list of devices users are allowed to specify for the
// -device switch, and the values they map to.
// -*- NEW DEVICE -*-
static const struct
{
const char* deviceName;
DeviceType deviceType;
}
kDevices[] =
{
{ "Pilot", kDevicePilot1000 },
{ "Pilot1000", kDevicePilot1000 },
{ "Pilot5000", kDevicePilot1000 },
{ "PalmPilot", kDevicePalmPilotPersonal },
{ "PalmIII", kDevicePalmIII },
{ "PalmIIIx", kDevicePalmIIIx },
{ "PalmV", kDevicePalmV },
{ "PalmVII", kDevicePalmVII },
{ "ColorDevice",kDeviceAustin },
{ "PalmVIIEZ", kDevicePalmVIIEZ }
};
typedef StringStringMap OptionList;
// Handy macro for helping us find and access options in the OptionList.
// For the option with the base name "name", this macro defines:
//
// "iter<name>" An iterator pointing to the named OptionList entry.
// "have<name>" A bool that says whether the iterator points to
// something valid.
// "opt<name>" A string reference that refers to the option value
// if "have<name>" is true.
#define DEFINE_VARS(name) \
OptionList::iterator iter##name = options.find(kOpt##name); \
Bool have##name = iter##name != options.end(); \
string& opt##name = iter##name->second
/***********************************************************************
*
* FUNCTION: PrvGetDatabaseInfosFromAppNames
*
* DESCRIPTION: Given a list of application names (as determined either
* by their 'tAIN' resources or their database names) and
* return AppInfos for all applications installed in the
* system with those names.
*
* PARAMETERS: names - the StringList with the names of the applications
* to search for. *All* executables are considered,
* includes .prc's and .pqa's.
*
* results - the DatabaseInfoList to receive the DatabaseInfos of
* the executables with a name that appears in the
* "names" collection.
*
* RETURNED: Nothing
*
***********************************************************************/
static void PrvGetDatabaseInfosFromAppNames (StringList& names, DatabaseInfoList& results)
{
if (!names.empty())
{
DatabaseInfoList dbInfos;
::GetDatabases (dbInfos, kApplicationsOnly);
DatabaseInfoList::iterator infoIter = dbInfos.begin();
while (infoIter != dbInfos.end())
{
string appInfoName(infoIter->name);
StringList::iterator nameIter = find (names.begin(), names.end(), appInfoName);
if (nameIter != names.end())
{
results.push_back (*infoIter);
}
++infoIter;
}
}
}
/***********************************************************************
*
* FUNCTION: PrvSetEmbeddedSessionPreferences
*
* DESCRIPTION: Sets special preferences for sessions that are being
* run out of embedded resources. Namely, we turn off
* debugging and logging features. These preferences do not
* "persist" on the system--that is, they are not written
* out to the preferences file after execution, so that
* other copies of Emulator (perhaps without sessions bound
* as resources) will continue to run unaffected.
*
* PARAMETERS: none
*
* RETURNED: none
*
***********************************************************************/
static void PrvSetPrefToFalse(const char *name)
{
Preference<bool> pref(name);
pref = false;
}
static void PrvSetPrefToZero(const char *name)
{
Preference<uae_u8> pref(name);
pref = 0;
}
static void PrvSetEmbeddedSessionPreferences(void)
{
PrvSetPrefToFalse(kPrefKeyRedirectNetLib);
PrvSetPrefToFalse(kPrefKeyReportCorruptedHeap);
PrvSetPrefToFalse(kPrefKeyReportCorruptedHeap);
PrvSetPrefToFalse(kPrefKeyReportFreeChunkAccess);
PrvSetPrefToFalse(kPrefKeyReportHardwareRegisterAccess);
PrvSetPrefToFalse(kPrefKeyReportInvalidPC);
PrvSetPrefToFalse(kPrefKeyReportLowMemoryAccess);
PrvSetPrefToFalse(kPrefKeyReportLowStackAccess);
PrvSetPrefToFalse(kPrefKeyReportMemMgrDataAccess);
PrvSetPrefToFalse(kPrefKeyReportMemMgrSemaphore);
PrvSetPrefToFalse(kPrefKeyReportScreenAccess);
PrvSetPrefToFalse(kPrefKeyReportStackAlmostOverflow);
PrvSetPrefToFalse(kPrefKeyReportStackOverflow);
PrvSetPrefToFalse(kPrefKeyReportStorageHeapAccess);
PrvSetPrefToFalse(kPrefKeyReportSysFatalAlert);
PrvSetPrefToFalse(kPrefKeyReportSystemGlobalAccess);
PrvSetPrefToFalse(kPrefKeyReportUnhandledException);
PrvSetPrefToFalse(kPrefKeyReportUnimplementedTrap);
PrvSetPrefToFalse(kPrefKeyReportUninitializedChunkAccess);
PrvSetPrefToFalse(kPrefKeyReportUninitializedStackAccess);
PrvSetPrefToFalse(kPrefKeyReportUnlockedChunkAccess);
PrvSetPrefToFalse(kPrefKeyReportMemoryLeaks);
PrvSetPrefToFalse(kPrefKeyReportLockedRecords);
PrvSetPrefToFalse(kPrefKeyInterceptSysFatalAlert);
PrvSetPrefToFalse(kPrefKeyFillNewBlocks);
PrvSetPrefToFalse(kPrefKeyFillResizedBlocks);
PrvSetPrefToFalse(kPrefKeyFillDisposedBlocks);
PrvSetPrefToFalse(kPrefKeyFillStack);
PrvSetPrefToZero(kPrefKeyLogErrorMessages);
PrvSetPrefToZero(kPrefKeyLogWarningMessages);
PrvSetPrefToZero(kPrefKeyLogGremlins);
PrvSetPrefToZero(kPrefKeyLogCPUOpcodes);
PrvSetPrefToZero(kPrefKeyLogEnqueuedEvents);
PrvSetPrefToZero(kPrefKeyLogDequeuedEvents);
PrvSetPrefToZero(kPrefKeyLogSystemCalls);
PrvSetPrefToZero(kPrefKeyLogApplicationCalls);
PrvSetPrefToZero(kPrefKeyLogSerial);
PrvSetPrefToZero(kPrefKeyLogSerialData);
PrvSetPrefToZero(kPrefKeyLogNetLib);
PrvSetPrefToZero(kPrefKeyLogNetLibData);
PrvSetPrefToZero(kPrefKeyLogExgMgr);
PrvSetPrefToZero(kPrefKeyLogExgMgrData);
PrvSetPrefToZero(kPrefKeyLogHLDebugger);
PrvSetPrefToZero(kPrefKeyLogHLDebuggerData);
PrvSetPrefToZero(kPrefKeyLogLLDebugger);
PrvSetPrefToZero(kPrefKeyLogLLDebuggerData);
}
/***********************************************************************
*
* FUNCTION: PrvDontUnderstand
* FUNCTION: PrvMissingArgument
* FUNCTION: PrvInvalidRAMSize
*
* DESCRIPTION: Display error messages concerning poor, misunderstood
* switches and their parameters.
*
* PARAMETERS: The switch ("-foo") guy who caused the problem.
*
* RETURNED: Nothing
*
***********************************************************************/
static void PrvDontUnderstand (const char* arg)
{
char buffer[200];
sprintf (buffer, "Don't understand the command line parameter \"%s\".", arg);
Platform::CommonDialog ("Fatal Error", buffer, Errors::kOK);
}
static void PrvMissingArgument (const char* arg)
{
char buffer[200];
sprintf (buffer, "The command line parameter \"%s\" needs to be followed by an "
"argument (\"No, it doesn't.\" \"Yes, it does.\" \"No, it doesn't...\").", arg);
Platform::CommonDialog ("Fatal Error", buffer, Errors::kOK);
}
static void PrvInvalidRAMSize (const char* arg)
{
char buffer[200];
sprintf (buffer, "\"%s\" is an invalid RAM size. Specify 128, 256, 512, 1024, "
"2048, 4096, or 8192.", arg);
Platform::CommonDialog ("Fatal Error", buffer, Errors::kOK);
}
/***********************************************************************
*
* FUNCTION: PrvCollectOptions
*
* DESCRIPTION: Breaks up the command line text into pairs of switches
* (the "-foo" part) and their optional parameters (anything
* that comes after the "-foo" part). Switches are
* validated, and they and any parameter are added to
* the given OptionList.
*
* PARAMETERS: argc, argv - standard C parameters describing the
* command line.
*
* options - the OptionList to received the parsed and
* validated parameters.
*
* RETURNED: True if everything went swimmingly. If an error occured
* (for instance, an invalid switch was specified or a
* switch that needed a parameter didn't have one), the
* error is reported and the function returns false.
*
***********************************************************************/
static Bool PrvCollectOptions (int argc, char** argv, OptionList& options)
{
// Iterate over the command line arguments.
for (int ii = 1; ii < argc;)
{
const char* arg = argv[ii++];
Bool handledOption = false;
// For each argument, see if it is a recognized switch.
for (int jj = 0; jj < countof (kOptionMap); ++jj)
{
if (_stricmp (arg, kOptionMap[jj].option) == 0)
{
// It's recognized; see if we need to also collect a parameter.
if (kOptionMap[jj].optType == 0)
{
// No parameter, just add the switch to our collection.
options[kOptionMap[jj].optKey] = "";
handledOption = true;
}
else if (kOptionMap[jj].optType == 1)
{
if (ii < argc)
{
// Add the switch and parameter to our collection.
options[kOptionMap[jj].optKey] = argv[ii++];
handledOption = true;
}
else
{
// Needed a parameter, but there wasn't one.
::PrvMissingArgument (arg);
return false;
}
}
}
}
// Did not understand the argument.
if (!handledOption)
{
#if 1
if ((arg[0] != '-') && (options.find(kOptPSF) != options.end()))
{
// For temporary backward compatibility, "bare" file names are treated
// as paths to .psf files.
options[kOptPSF] = arg;
}
else
#endif
{
::PrvDontUnderstand (arg);
return false;
}
}
}
return true;
}
/***********************************************************************
*
* FUNCTION: PrvConvertRAM
*
* DESCRIPTION: Convert a -ram parameter into a number and validate it.
*
* PARAMETERS: str - the switch parameter.
*
* ramSize - the RAMSizeType to receive the converted value.
*
* RETURNED: True if everything went well. If the resulting value
* was not a valid RAMSizeType value, then returns false.
*
***********************************************************************/
static Bool PrvConvertRAM(const string& str, RAMSizeType& ramSize)
{
ramSize = atol (str.c_str ());
MemoryTextList sizes;
::GetMemoryTextList (sizes);
MemoryTextList::iterator iter = sizes.begin();
while (iter != sizes.end())
{
if (ramSize == iter->first)
{
return true;
}
++iter;
}
return false;
}
/***********************************************************************
*
* FUNCTION: PrvConvertDevice
*
* DESCRIPTION: Convert a -device parameter into a DeviceType value
* and validate it.
*
* PARAMETERS: str - the switch parameter.
*
* device - the DeviceType to receive the converted value.
*
* RETURNED: True if everything went well. If the resulting value
* was not a valid DeviceType value, then returns false.
*
***********************************************************************/
static Bool PrvConvertDevice(const string& str, DeviceType& device)
{
for (int ii = 0; ii < countof(kDevices); ++ii)
{
if (_stricmp(str.c_str(), kDevices[ii].deviceName) == 0)
{
device = kDevices[ii].deviceType;
return true;
}
}
return false;
}
/***********************************************************************
*
* FUNCTION: PrvParseFileList
*
* DESCRIPTION: Break up a comma-delimited list of files, returning the
* pieces in a FileRefList.
*
* PARAMETERS: fileList - the FileRefList to receive the files from the
* comma-delimited list. This collection is *not* first
* cleared out, so it's possible to add to the
* collection with this function.
*
* option - the string containing the comma-delimited files.
*
* RETURNED: Nothing
*
***********************************************************************/
static void PrvParseFileList (FileRefList& fileList, string option)
{
StringList items;
::SeperateList (items, option, ',');
StringList::iterator iter = items.begin();
while (iter != items.end())
{
fileList.push_back (FileReference(*iter));
++iter;
}
}
/***********************************************************************
*
* FUNCTION: PrvHandleOpenSessionParameters
*
* DESCRIPTION: Handle the following command line options:
*
* kOptPSF
*
* PARAMETERS: options - the OptionList containing the complete set
* of parsed switches and parameters.
*
* RETURNED: True if everything when OK. If there's something wrong
* with the specifications, this function displays an
* error message and return false.
*
***********************************************************************/
static Bool PrvHandleOpenSessionParameters (OptionList& options)
{
DEFINE_VARS(PSF);
if (havePSF)
{
FileReference psfRef = FileReference (optPSF);
Startup::ScheduleOpenSession(psfRef);
}
return true;
}
/***********************************************************************
*
* FUNCTION: PrvHandleCreateSessionParameters
*
* DESCRIPTION: Handle the following command line options:
*
* kOptROM
* kOptRAM
* kOptDevice
*
* PARAMETERS: options - the OptionList containing the complete set
* of parsed switches and parameters.
*
* RETURNED: True if everything when OK. If there's something wrong
* with the specifications, this function displays an
* error message and return false.
*
***********************************************************************/
static Bool PrvHandleCreateSessionParameters (OptionList& options)
{
DEFINE_VARS(ROM);
DEFINE_VARS(RAM);
DEFINE_VARS(Device);
Bool haveSome = haveROM || haveRAM || haveDevice;
Bool haveAll = haveROM && haveRAM && haveDevice;
if (haveSome)
{
Configuration cfg;
// Check for a specified ROM file.
if (haveROM)
{
cfg.fROMFile = FileReference (optROM);
}
// Check for a specified RAM size.
if (haveRAM)
{
if (!::PrvConvertRAM(optRAM, cfg.fRAMSize))
{
::PrvInvalidRAMSize (optRAM.c_str ());
return false;
}
}
// Check for a specified device type.
if (haveDevice)
{
if (!::PrvConvertDevice(optDevice, cfg.fDeviceType))
{
::PrvDontUnderstand (optDevice.c_str ());
return false;
}
}
// Try to start up with the specified parameters.
// If the command line didn't specify all the required values, ask for them.
if (!haveAll && !Platform::QueryNewDocument (cfg))
{
// User cancelled the "New Configuration" dialog.
// Bring up the dialog with the New/Open/Download/Exit buttons.
Startup::ScheduleAskWhatToDo();
}
else
{
Startup::ScheduleCreateSession(cfg);
}
}
return true;
}
/***********************************************************************
*
* FUNCTION: PrvHandleNewHordeParameters
*
* DESCRIPTION: Handle the following command line options:
*
* kOptHordeFirst
* kOptHordeLast
* kOptHordeApps
* kOptHordeSaveDir
* kOptHordeSaveFreq
* kOptHordeDepthMax
* kOptHordeDepthSwitch
*
* PARAMETERS: options - the OptionList containing the complete set
* of parsed switches and parameters.
*
* RETURNED: True if everything when OK. If there's something wrong
* with the specifications, this function displays an
* error message and return false.
*
***********************************************************************/
static Bool PrvHandleNewHordeParameters (OptionList& options)
{
DEFINE_VARS(HordeFirst);
DEFINE_VARS(HordeLast);
DEFINE_VARS(HordeApps);
DEFINE_VARS(HordeSaveDir);
DEFINE_VARS(HordeSaveFreq);
DEFINE_VARS(HordeDepthMax);
DEFINE_VARS(HordeDepthSwitch);
if (haveHordeFirst ||
haveHordeLast ||
haveHordeApps ||
haveHordeSaveDir ||
haveHordeSaveFreq ||
haveHordeDepthMax ||
haveHordeDepthSwitch)
{
HordeInfo info;
StringList appNames;
if (haveHordeFirst)
{
info.fStartNumber = atoi (optHordeFirst.c_str());
if (!haveHordeLast)
{
info.fStopNumber = info.fStartNumber;
}
}
if (haveHordeLast)
{
info.fStopNumber = atoi (optHordeLast.c_str());
if (!haveHordeFirst)
{
info.fStartNumber = info.fStopNumber;
}
}
if (!haveHordeFirst && !haveHordeLast)
{
info.fStartNumber = 0;
info.fStopNumber = 0;
}
if (haveHordeApps)
{
// Get the list of user-specified names.
// We can't do much more with them now -- like look up
// the applications on the device -- as the device may
// not be up and running at this time. We have to defer
// doing that until we're ready to start the Gremlin.
::SeperateList (appNames, optHordeApps, ',');
}
if (haveHordeSaveDir)
{
Hordes::SetGremlinsHome(optHordeSaveDir.c_str());
}
else
{
Hordes::SetGremlinsHomeToDefault();
}
if (haveHordeSaveFreq)
{
info.fSaveFrequency = atoi (optHordeSaveFreq.c_str());
}
if (haveHordeDepthMax)
{
info.fMaxDepth = atoi (optHordeDepthMax.c_str());
}
if (haveHordeDepthSwitch)
{
info.fSwitchDepth = atoi (optHordeDepthSwitch.c_str());
}
Startup::ScheduleNewHorde (info, appNames);
}
return true;
}
/***********************************************************************
*
* FUNCTION: PrvHandleAutoLoadParameters
*
* DESCRIPTION: Handle the following command line options:
*
* kOptLoad
* kOptRun
* kOptQuitOnExit
*
* PARAMETERS: options - the OptionList containing the complete set
* of parsed switches and parameters.
*
* RETURNED: True if everything when OK. If there's something wrong
* with the specifications, this function displays an
* error message and return false.
*
***********************************************************************/
static Bool PrvHandleAutoLoadParameters (OptionList& options)
{
DEFINE_VARS(Load);
DEFINE_VARS(Run);
DEFINE_VARS(QuitOnExit);
if (haveLoad)
{
::PrvParseFileList (gAutoLoadFiles1, optLoad);
}
if (haveRun)
{
gAutoRunApp = optRun;
}
if (haveQuitOnExit)
{
Startup::ScheduleQuitOnExit();
}
return true;
}
/***********************************************************************
*
* FUNCTION: PrvParseCommandLine
*
* DESCRIPTION: Parse up the command line into its consituent parts,
* validate the parts, and act on the specifications.
*
* PARAMETERS: argc, argv - standard C parameters describing the
* command line.
*
* RETURNED: Nothing. All actions to be taken based on the users
* specifications are recorded in global variables.
*
***********************************************************************/
static void PrvParseCommandLine (int argc, char** argv)
{
OptionList options;
// Convert the command line into a map of switch/parameter pairs.
if (!::PrvCollectOptions(argc, argv, options))
goto BadParameter;
// Handle kOptPSF.
if (!::PrvHandleOpenSessionParameters(options))
goto BadParameter;
// Handle kOptROM, kOptRAM, and kOptDevice.
if (!::PrvHandleCreateSessionParameters(options))
goto BadParameter;
// Handle kOptHordeFirst, kOptHordeLast, kOptHordeApps, kOptHordeSaveDir,
// kOptHordeSaveFreq, kOptHordeDepthMax, and kOptHordeDepthSwitch.
if (!::PrvHandleNewHordeParameters(options))
goto BadParameter;
// Handle kOptLoad, kOptRun, and kOptQuitOnExit.
if (!::PrvHandleAutoLoadParameters(options))
goto BadParameter;
// Handle kOptSkin
// !!! TBD
// Handle kOptLog
// !!! TBD
return;
BadParameter:
// All bets are off. Bring up the dialog with the
// New/Open/Download/Exit buttons.
Startup::ScheduleAskWhatToDo();
return;
}
/***********************************************************************
*
* FUNCTION: Startup::DetermineStartupActions
*
* DESCRIPTION: Determine what to do at startup time, based on any
* command-line options, what the user was doing when they
* last ran Poser, and whether or not the CapsLock key
* is toggled.
*
* In general, the startup rules are as follows:
*
* 1 If the Caps Lock key is toggled in the ON position, always bring
* up the New/Open/... dialog.
*
* 2 Scan the command line for startup parameters. If an error occurs
* trying to scan the command line, the error is reported and the user
* is presented with the New/Open/... dialog.
*
* 3 Use the .psf file if one is specified. If an error occurs trying
* to load the file, the error is reported and the user is presented
* with the New/Open/... dialog.
*
* 4 If any of -rom, -ram, -device, or -silkscreen are specified, try
* to start a new session based on those values. If all are specified,
* the new session is automatically created. If any of those four
* values are missing, the "New Configuration" dialog is displayed.
* If the user cancels the dialog, or if there is an error creating
* the new session, any error is reported and the user is presented
* with the New/Open/... dialog.
*
* 5 If no command line options are specified, try re-opening the last
* saved .psf file (this step is skipped if the user last created a
* new session, but did NOT save that session to a file). If an error
* occurs trying to load the file, the error is reported and the user
* is presented with the New/Open/... dialog.
*
* 6 Try creating a new session based on the settings the user last
* specified when creating a session. If there is an error creating
* the new session, the error is reported and the user is presented
* with the New/Open/... dialog.
*
* 7 Finally, if all else fails, present the user with the New/Open/...
* dialog.
*
* PARAMETERS: argc, argv - standard C parameters describing the
* command line.
*
* RETURNED: True if we were able to determine a startup course of
* action. If false is returned, something horrible happened.
* The caller should assume that an error was reported,
* and that the application should quit.
*
***********************************************************************/
Bool Startup::DetermineStartupActions (int argc, char** argv)
{
// By default, throw up our hands.
Startup::ScheduleAskWhatToDo ();
// See if the user wants to force the appearance of the Startup
// screen (by holding down the ShiftLock key) and skip the auto-
// loading of the previous session file.
if (!Platform::ForceStartupScreen ())
{
Preference<Configuration> pref1 (kPrefKeyLastConfiguration);
Preference<FileReference> pref2 (kPrefKeyLastPSF);
Configuration cfg = *pref1;
FileReference ramFileRef = *pref2;
// See if there is embedded PSF resource. If so, use it.
if (Platform::PSFResourcePresent())
{
// Bail if there is an embedded PSF without an embedded ROM.
if (!Platform::ROMResourcePresent())
{
Platform::CommonDialog("Fatal Error",
"An embedded PSF has been detected, but there is no "
"corresponding embedded ROM file. Palm OS Emulator "
"cannot be run in this state and will quit.",
Errors::kOK);
return false;
}
::PrvSetEmbeddedSessionPreferences();
Startup::ScheduleOpenSession (ramFileRef); // Ref ignored...
}
// Else, see if there is an embedded ROM. If so, we will be creating a
// new document based on it.
else if (Platform::ROMResourcePresent())
{
// If we have an an embedded ROM without an embedded PSF, we should
// have a resource configuration.
if (!Platform::ConfigResourcePresent())
{
Platform::CommonDialog("Fatal Error",
"An embedded ROM has been detected, but there is neither an "
"embedded PSF now a device configuration. Palm OS Emulator "
"cannot be run in this state and will quit.",
Errors::kOK);
return false;
}
// Get the configuration settings from the embedded configuration.
// If we can get them, create a new document based on them.
if (Platform::GetEmbeddedDeviceType(cfg.fDeviceType) &&
Platform::GetEmbeddedRAMSize(cfg.fRAMSize))
{
Startup::ScheduleCreateSession (cfg); // ROM image comes from resource...
}
}
// Else, see if there was a previously saved RAM file. If so, open it.
else if (ramFileRef.IsSpecified ())
{
Startup::ScheduleOpenSession (ramFileRef);
}
// Else, see if there was a previously created document. If so,
// create a new document based on its settings.
else if (cfg.fDeviceType != kDeviceUnspecified &&
cfg.fRAMSize != 0 &&
cfg.fROMFile.IsSpecified () )
{
Startup::ScheduleCreateSession (cfg);
}
// Now that default actions have been established, let's see if
// there's anything interesting on the command line -- UNLESS we have
// an embedded session file.
if (!Platform::PSFResourcePresent())
{
::PrvParseCommandLine (argc, argv);
}
}
return true;
}
/***********************************************************************
*
* FUNCTION: Startup::GetAutoLoads
*
* DESCRIPTION: Return the list of applications that should automatically
* be loaded at startup time, regardless of whether a new
* session was created or an old one loaded. The list of
* applications is collected from the command line and from
* the specially-named AutoLoad, AutoRun, and AutoRunAndQuit
* directories.
*
* PARAMETERS: fileList - the FileRefList to receive the files to load.
* The collection is cleared out before the new items
* are added to it.
*
* RETURNED: Nothing
*
***********************************************************************/
static void PrvLookForAutoloads (void)
{
gAutoLoadFiles2.clear();
gAutoRunFiles2.clear();
gAutoRunAndQuitFiles2.clear();
Platform::GetLoadableFileList (Platform::GetString (kStr_Autoload), gAutoLoadFiles2);
Platform::GetLoadableFileList (Platform::GetString (kStr_Autorun), gAutoRunFiles2);
Platform::GetLoadableFileList (Platform::GetString (kStr_AutorunAndQuit), gAutoRunAndQuitFiles2);
}
static void PrvAppendFiles (FileRefList& list1, const FileRefList& list2)
{
list1.insert(list1.end(), list2.begin(), list2.end());
}
void Startup::GetAutoLoads (FileRefList& fileList)
{
fileList.clear();
::PrvLookForAutoloads();
::PrvAppendFiles (fileList, gAutoLoadFiles1);
// ::PrvAppendFiles (fileList, gAutoRunFiles1);
// ::PrvAppendFiles (fileList, gAutoRunAndQuitFiles1);
::PrvAppendFiles (fileList, gAutoLoadFiles2);
::PrvAppendFiles (fileList, gAutoRunFiles2);
::PrvAppendFiles (fileList, gAutoRunAndQuitFiles2);
if (/*gAutoRunAndQuitFiles1.size() +*/ gAutoRunAndQuitFiles2.size() > 0)
{
Startup::ScheduleQuitOnExit ();
}
}
/***********************************************************************
*
* FUNCTION: Startup::GetAutoRunApp
*
* DESCRIPTION: Returns the *database name* of the application to
* switch to at startup time.
*
* PARAMETERS: None
*
* RETURNED: The name of the database of the executable.
*
***********************************************************************/
static string PrvTryGetApp (const FileRefList& fileList)
{
string result;
FileRefList::const_iterator iter = fileList.begin();
while (iter != fileList.end())
{
if ((*iter).IsPRC()) // egcs can't handle iter->IsPRC()!!!
{
try
{
FileHandle openFile (*iter, kOpenExisting | kOpenRead);
DatabaseHdrType header;
openFile.Read (sizeof (DatabaseHdrType), &header);
Canonical(header);
if (::IsExecutable (header.type, header.creator, header.attributes))
{
result = (char*) header.name;
break;
}
}
catch (...)
{
}
}
++iter;
}
return result;
}
string Startup::GetAutoRunApp (void)
{
string result;
// Get the name the user specified on the command line (if any)
// and get the DatabaseInfo for it, so that we can get the database name.
if (!gAutoRunApp.empty())
{
StringList appNames;
appNames.push_back (gAutoRunApp);
DatabaseInfoList dbInfos;
::PrvGetDatabaseInfosFromAppNames (appNames, dbInfos);
if (dbInfos.size() > 0)
{
result = dbInfos.begin()->dbName;
}
}
// If the user didn't specify an executable, or we couldn't find
// that executable, then work from the files found in the AutoRun
// and AutoRunAndQuit directories.
// if (result.empty())
// result = ::PrvTryGetApp (gAutoRunFiles1);
if (result.empty())
result = ::PrvTryGetApp (gAutoRunFiles2);
// if (result.empty())
// result = ::PrvTryGetApp (gAutoRunAndQuitFiles1);
if (result.empty())
result = ::PrvTryGetApp (gAutoRunAndQuitFiles2);
return result;
}
/***********************************************************************
*
* FUNCTION: Startup::AskWhatToDo
*
* DESCRIPTION: Return whether or not we are supposed to ask the user
* what to do (that is, display the dialog box with the
* New, Open, Download, and Quit buttons). In general,
* this function returns true if there's nothing else
* scheduled to be done (create a session, open a session,
* or quit the emulator).
*
* PARAMETERS: None
*
* RETURNED: True if so.
*
***********************************************************************/
Bool Startup::AskWhatToDo (void)
{
// Bool result = gAskWhatToDo;
// gAskWhatToDo = false;
// return result;
return !gCreateSession && !gOpenSession && !gQuit && !gClose;
}
/***********************************************************************
*
* FUNCTION: Startup::CreateSession
*
* DESCRIPTION: Return whether or not we are supposed to create a new
* session based on previously determined criteria. This
* is a one-shot function: subsequent calls will return
* false until ScheduleCreateSession is called again.
*
* PARAMETERS: cfg - the Configuration to receive the information to
* be used when creating the new session.
*
* RETURNED: True if so.
*
***********************************************************************/
Bool Startup::CreateSession (Configuration& cfg)
{
Bool result = gCreateSession;
if (result)
cfg = gCfg;
gCreateSession = false;
return result;
}
/***********************************************************************
*
* FUNCTION: Startup::OpenSession
*
* DESCRIPTION: Return whether or not we are supposed to open an old
* session based on previously determined criteria. This
* is a one-shot function: subsequent calls will return
* false until ScheduleOpenSession is called again.
*
* PARAMETERS: ref - the FileReference to receive the reference to
* the .psf file to be opened.
*
* RETURNED: True if so.
*
***********************************************************************/
Bool Startup::OpenSession (FileReference& ref)
{
Bool result = gOpenSession;
if (result)
ref = gSessionOpenRef;
gOpenSession = false;
return result;
}
/***********************************************************************
*
* FUNCTION: Startup::NewHorde
*
* DESCRIPTION: Return whether or not we are supposed to start a horde
* session based on previously determined criteria. This
* is a one-shot function: subsequent calls will return
* false until ScheduleNewHorde is called again.
*
* PARAMETERS: info - the HordeInfo to receive the information used to
* create the new horde.
*
* RETURNED: True if so.
*
***********************************************************************/
Bool Startup::NewHorde (HordeInfo* info)
{
Bool result = gStartNewHorde;
if (info != NULL)
{
if (result)
{
*info = gHorde;
// Find the AppInfos for the user-specified applications.
::PrvGetDatabaseInfosFromAppNames (gHordeApps, info->fAppList);
}
gStartNewHorde = false;
}
return result;
}
/***********************************************************************
*
* FUNCTION: Startup::CloseSession
*
* DESCRIPTION: Return whether or not Poser is supposed to close the
* current session right now.
*
* PARAMETERS: None
*
* RETURNED: True if so.
*
***********************************************************************/
Bool Startup::CloseSession (FileReference& f)
{
Bool result = gClose;
f = gSessionCloseRef;
gClose = false;
return result;
}
/***********************************************************************
*
* FUNCTION: Startup::QuitOnExit
*
* DESCRIPTION: Return whether or not Poser is supposed to quit when
* a particular application exits.
*
* PARAMETERS: None
*
* RETURNED: True if so.
*
***********************************************************************/
Bool Startup::QuitOnExit (void)
{
Bool result = gQuitOnExit;
// gQuitOnExit = false;
return result;
}
/***********************************************************************
*
* FUNCTION: Startup::Quit
*
* DESCRIPTION: Return whether or not it's time to quit.
*
* PARAMETERS: None
*
* RETURNED: True if so.
*
***********************************************************************/
Bool Startup::Quit (void)
{
Bool result = gQuit;
gQuit = false;
return result;
}
/***********************************************************************
*
* FUNCTION: Startup::Clear
*
* DESCRIPTION: Clear all settings.
*
* PARAMETERS: None
*
* RETURNED: Nothing
*
***********************************************************************/
void Startup::Clear (void)
{
gCreateSession = false;
gOpenSession = false;
gStartNewHorde = false;
gQuitOnExit = false;
gQuit = false;
gAutoRunApp = "";
gAutoLoadFiles1.clear();
gAutoLoadFiles2.clear();
gAutoRunFiles2.clear();
gAutoRunAndQuitFiles2.clear();
}
/***********************************************************************
*
* FUNCTION: Startup::ScheduleAskWhatToDo
*
* DESCRIPTION: Schedule our "state machine" so that AskWhatToDo will
* return True.
*
* PARAMETERS: None
*
* RETURNED: Nothing
*
***********************************************************************/
void Startup::ScheduleAskWhatToDo (void)
{
Startup::Clear ();
// gAskWhatToDo = true;
}
/***********************************************************************
*
* FUNCTION: Startup::ScheduleCreateSession
*
* DESCRIPTION: Schedule our "state machine" so that CreateSession will
* return True.
*
* PARAMETERS: cfg - the Configuration returned to the caller of
* CreatSession.
*
* RETURNED: Nothing
*
***********************************************************************/
void Startup::ScheduleCreateSession (const Configuration& cfg)
{
gCreateSession = true;
// gAskWhatToDo = false;
gCfg = cfg;
}
/***********************************************************************
*
* FUNCTION: Startup::ScheduleOpenSession
*
* DESCRIPTION: Schedule our "state machine" so that OpenSession will
* return True.
*
* PARAMETERS: ref - the FileReference returned to the caller of
* OpenSession.
*
* RETURNED: Nothing
*
***********************************************************************/
void Startup::ScheduleOpenSession (const FileReference& ref)
{
gOpenSession = true;
// gAskWhatToDo = false;
gSessionOpenRef = ref;
}
/***********************************************************************
*
* FUNCTION: Startup::ScheduleNewHorde
*
* DESCRIPTION: Schedule our "state machine" so that NewHorde will
* return True.
*
* PARAMETERS: info - the HordeInfo returned to the caller of NewHorde.
*
* appNames - names of the applications to inflict the
* Gremlins on. Normally, this information is
* specified in the fAppList field of the HordeInfo.
* However, at the time this function is called,
* we may not be able to generate the DatabaseInfoList
* (the emulator may be just starting up and not
* emulating a Palm OS environment, yet). So we
* remember the names here. When NewHorde is called,
* the appNames list is converted into an DatabaseInfoList.
*
* RETURNED: Nothing
*
***********************************************************************/
void Startup::ScheduleNewHorde (const HordeInfo& info, const StringList& appNames)
{
gStartNewHorde = true;
gHorde = info;
gHordeApps = appNames;
}
/***********************************************************************
*
* FUNCTION: Startup::ScheduleCloseSession
*
* DESCRIPTION: Schedule our "state machine" so that CloseSession will
* return True.
*
* PARAMETERS: None
*
* RETURNED: Nothing
*
***********************************************************************/
void Startup::ScheduleCloseSession (const FileReference& f)
{
gSessionCloseRef = f;
gClose = true;
}
/***********************************************************************
*
* FUNCTION: Startup::ScheduleQuitOnExit
*
* DESCRIPTION: Schedule our "state machine" so that QuitOnExit will
* return True.
*
* PARAMETERS: None
*
* RETURNED: Nothing
*
***********************************************************************/
void Startup::ScheduleQuitOnExit (void)
{
gQuitOnExit = true;
}
/***********************************************************************
*
* FUNCTION: Startup::ScheduleQuit
*
* DESCRIPTION: Schedule our "state machine" so that Quit will
* return True.
*
* PARAMETERS: None
*
* RETURNED: Nothing
*
***********************************************************************/
void Startup::ScheduleQuit (void)
{
// Startup::Clear();
gQuit = true;
// gAskWhatToDo = false;
}
|