workbench/classes/zune/aboutwindow/aboutwindow.c

   1 /*
   2     Copyright © 2003-2004, The AROS Development Team. All rights reserved.
   3     This file is part of the AboutWindow class, which is distributed under
   4     the terms of version 2.1 of the GNU Lesser General Public License.
   5
   6     $Id$
   7 */
   8
   9 #define MUIMASTER_YES_INLINE_STDARG
  10
  11 #include <exec/memory.h>
  12 #include <utility/tagitem.h>
  13 #include <dos/dos.h>
  14 #include <libraries/mui.h>
  15 #include <zune/iconimage.h>
  16
  17 #include <proto/exec.h>
  18 #include <proto/muimaster.h>
  19 #include <proto/intuition.h>
  20 #include <proto/utility.h>
  21 #include <proto/locale.h>
  22 #include <proto/dos.h>
  23 #include <clib/alib_protos.h>   /* StrDup() */
  24
  25 #include <string.h>
  26
  27 #include "aboutwindow.h"
  28 #include "aboutwindow_private.h"
  29
  30 #define CATCOMP_ARRAY
  31 #include "strings.h"
  32
  33 /*** Locale Functions *******************************************************/
  34 CONST_STRPTR MSG(struct Catalog *catalog, ULONG id)
  35 {
  36     if (catalog != NULL)
  37     {
  38         return GetCatalogStr(catalog, id, CatCompArray[id].cca_Str);
  39     }
  40     else
  41     {
  42         return CatCompArray[id].cca_Str;
  43     }
  44 }
  45
  46 #define _(id) MSG(catalog,id)
  47
  48 /*** Macros and Defines *****************************************************/
  49 #define IGNORE ((APTR)(1UL))
  50
  51 /*** Utility ****************************************************************/
  52 CONST_STRPTR Section2Name(struct Catalog *catalog, ULONG section)
  53 {
  54     switch (section)
  55     {
  56         case SID_PROGRAMMING:
  57             return _(MSG_SECTION_PROGRAMMING);
  58
  59         case SID_TRANSLATING:
  60             return _(MSG_SECTION_TRANSLATING);
  61
  62         default:
  63             return NULL;
  64     }
  65 }
  66
  67 BOOL NamesToList
  68 (
  69     Object *list, struct TagItem *tags, struct AboutWindow_DATA *data
  70 )
  71 {
  72     struct TagItem *tstate       = tags,
  73                    *tag          = NULL;
  74     BOOL            success      = TRUE;
  75     IPTR            section      = SID_NONE;
  76     CONST_STRPTR    sectionName  = NULL;
  77     BOOL            sectionFirst = TRUE;
  78     STRPTR          name;
  79     STRPTR          buffer;
  80     ULONG           length       = 0;
  81
  82     if (tags == NULL) return FALSE;
  83
  84     while ((tag = NextTagItem(&tstate)) != NULL && success == TRUE)
  85     {
  86         switch (tag->ti_Tag)
  87         {
  88             case SECTION_ID:
  89                 section     = tag->ti_Data;
  90                 sectionName = Section2Name(data->awd_Catalog, section);
  91
  92                 if (sectionName != NULL)
  93                 {
  94                     sectionFirst
  95                         ? sectionFirst = FALSE
  96                         : DoMethod(list, MUIM_List_InsertSingle, (IPTR) "");
  97
  98                     length = strlen(MUIX_B) + strlen(sectionName) + 1;
  99                     buffer = AllocPooled(data->awd_Pool, length);
 100                     if (buffer != NULL)
 101                     {
 102                         buffer[0] = '\0';
 103                         strcat(buffer, MUIX_B);
 104                         strcat(buffer, sectionName);
 105
 106                         DoMethod
 107                         (
 108                             list, MUIM_List_InsertSingle,
 109                             (IPTR) buffer, MUIV_List_Insert_Bottom
 110                         );
 111                     }
 112                     else
 113                     {
 114                         success = FALSE;
 115                         break;
 116                     }
 117                 }
 118
 119                 break;
 120
 121             case NAME_STRING:
 122                 name   = (STRPTR) tag->ti_Data;
 123
 124                 length = strlen(name) + 1;
 125                 if (sectionName != NULL) length += 4;
 126
 127                 buffer = AllocPooled(data->awd_Pool, length);
 128                 if (buffer != NULL)
 129                 {
 130                     buffer[0] = '\0';
 131                     if (sectionName != NULL) strcat(buffer, "    ");
 132                     strcat(buffer, name);
 133
 134                     DoMethod
 135                     (
 136                         list, MUIM_List_InsertSingle,
 137                         (IPTR) buffer, MUIV_List_Insert_Bottom
 138                     );
 139                 }
 140                 else
 141                 {
 142                     success = FALSE;
 143                     break;
 144                 }
 145
 146                 break;
 147         }
 148     }
 149
 150     return success;
 151 }
 152
 153 /*** Methods ****************************************************************/
 154 Object *AboutWindow__OM_NEW
 155 (
 156     Class *CLASS, Object *self, struct opSet *message
 157 )
 158 {
 159     struct AboutWindow_DATA *data              = NULL;
 160     struct TagItem          *tag               = NULL,
 161                             *tstate            = message->ops_AttrList,
 162                             *authorsTags       = NULL,
 163                             *sponsorsTags      = NULL;
 164     struct Catalog          *catalog           = NULL;
 165     APTR                     pool;
 166     Object                  *rootGroup         = NULL,
 167                             *imageGroup        = NULL,
 168                             *imageObject       = NULL,
 169                             *versionObject     = NULL,
 170                             *copyrightObject   = NULL,
 171                             *descriptionGroup  = NULL,
 172                             *descriptionObject = NULL,
 173                             *authorsList       = NULL,
 174                             *sponsorsList      = NULL;
 175
 176     STRPTR                   title             = NULL,
 177                              versionNumber     = NULL,
 178                              versionDate       = NULL,
 179                              versionExtra      = NULL,
 180                              description       = NULL,
 181                              copyright         = NULL;
 182
 183     CONST_STRPTR             pages[]           = { NULL, NULL, NULL };
 184     UBYTE                    nextPage          = 0;
 185
 186     /* Allocate memory pool ------------------------------------------------*/
 187     pool = CreatePool(MEMF_ANY, 4096, 4096);
 188     if (pool == NULL) return NULL;
 189
 190     /* Initialize locale ---------------------------------------------------*/
 191     catalog = OpenCatalogA
 192     (
 193         NULL, "System/Classes/Zune/AboutWindow.catalog", NULL
 194     );
 195
 196     /* Parse initial attributes --------------------------------------------*/
 197     while ((tag = NextTagItem(&tstate)) != NULL)
 198     {
 199         switch (tag->ti_Tag)
 200         {
 201             case MUIA_AboutWindow_Image:
 202                 imageObject = (Object *) tag->ti_Data;
 203                 break;
 204
 205             case MUIA_AboutWindow_Title:
 206                 title = StrDup((STRPTR) tag->ti_Data);
 207                 if (title == NULL) title = IGNORE;
 208                 break;
 209
 210             case MUIA_AboutWindow_Version_Number:
 211                 versionNumber = StrDup((STRPTR) tag->ti_Data);
 212                 if (versionNumber == NULL) versionNumber = IGNORE;
 213                 break;
 214
 215             case MUIA_AboutWindow_Version_Date:
 216                 versionDate = StrDup((STRPTR) tag->ti_Data);
 217                 if (versionDate == NULL) versionDate = IGNORE;
 218                 break;
 219
 220             case MUIA_AboutWindow_Version_Extra:
 221                 versionExtra = StrDup((STRPTR) tag->ti_Data);
 222                 if (versionExtra == NULL) versionExtra = IGNORE;
 223                 break;
 224
 225             case MUIA_AboutWindow_Copyright:
 226                 copyright = StrDup((STRPTR) tag->ti_Data);
 227                 if (copyright == NULL) copyright = IGNORE;
 228                 break;
 229
 230             case MUIA_AboutWindow_Description:
 231                 description = StrDup((STRPTR) tag->ti_Data);
 232                 if (description == NULL) description = IGNORE;
 233                 break;
 234
 235             case MUIA_AboutWindow_Authors:
 236                 authorsTags = (struct TagItem *) tag->ti_Data;
 237                 break;
 238
 239             case MUIA_AboutWindow_Sponsors:
 240                 sponsorsTags = (struct TagItem *) tag->ti_Data;
 241                 break;
 242
 243             default:
 244                 continue; /* Don't supress non-processed tags */
 245         }
 246
 247         tag->ti_Tag = TAG_IGNORE;
 248     }
 249
 250     /* Setup image ---------------------------------------------------------*/
 251     if (imageObject == NULL)
 252     {
 253         TEXT path[512], program[1024]; path[0] = '\0'; program[0] = '\0';
 254
 255         if (GetProgramName(program, 1024))
 256         {
 257             strlcat(path, "PROGDIR:", 512);
 258             strlcat(path, FilePart(program), 512);
 259             imageObject = IconImageObject,
 260                 MUIA_IconImage_File, (IPTR) path,
 261             End;
 262         }
 263
 264         if (imageObject == NULL)
 265         {
 266             imageObject = HVSpace;
 267         }
 268     }
 269
 270     /* Setup pages ---------------------------------------------------------*/
 271     if (authorsTags != NULL)
 272     {
 273         pages[nextPage] = _(MSG_AUTHORS);
 274         nextPage++;
 275     }
 276
 277     if (sponsorsTags != NULL)
 278     {
 279         pages[nextPage] = _(MSG_SPONSORS);
 280         nextPage++;
 281     }
 282
 283     self = (Object *) DoSuperNewTags
 284     (
 285         CLASS, self, NULL,
 286
 287         MUIA_Window_Activate, TRUE,
 288         MUIA_Window_NoMenus,  TRUE,
 289         MUIA_Window_Height,   MUIV_Window_Height_Visible(25),
 290         MUIA_Window_Width,    MUIV_Window_Width_Visible(25),
 291
 292         WindowContents, (IPTR) VGroup,
 293             GroupSpacing(6),
 294
 295             Child, (IPTR) (imageGroup = HGroup,
 296                 MUIA_Weight,  0,
 297
 298                 Child, (IPTR) HVSpace,
 299                 Child, (IPTR) imageObject,
 300                 Child, (IPTR) HVSpace,
 301             End),
 302             Child, (IPTR) (versionObject = TextObject,
 303                 MUIA_Text_PreParse, (IPTR) MUIX_C,
 304                 MUIA_Text_Contents, (IPTR) NULL,
 305             End),
 306             Child, (IPTR) (copyrightObject = TextObject,
 307                 MUIA_Text_PreParse, (IPTR) MUIX_C,
 308                 MUIA_Text_Contents, (IPTR) NULL,
 309             End),
 310             Child, (IPTR) (descriptionGroup = VGroup,
 311                 Child, (IPTR) VSpace(6),
 312                 Child, (IPTR) (descriptionObject = TextObject,
 313                     MUIA_Text_PreParse, (IPTR) MUIX_I MUIX_C,
 314                     MUIA_Text_Contents, (IPTR) NULL,
 315                 End),
 316             End),
 317             Child, (IPTR) VSpace(6),
 318             Child, (IPTR) RegisterGroup(pages),
 319                 Child, (IPTR) ListviewObject,
 320                     MUIA_Listview_List, (IPTR) (authorsList = ListObject,
 321                         ReadListFrame,
 322                     End),
 323                 End,
 324                 Child, (IPTR) ListviewObject,
 325                     MUIA_Listview_List, (IPTR) (sponsorsList = ListObject,
 326                         ReadListFrame,
 327                     End),
 328                 End,
 329             End,
 330         End,
 331
 332         TAG_MORE, (IPTR) message->ops_AttrList
 333     );
 334
 335     if (self == NULL) goto error;
 336
 337     data = INST_DATA(CLASS, self);
 338     data->awd_Catalog           = catalog;
 339     data->awd_Pool              = pool;
 340     data->awd_RootGroup         = rootGroup;
 341     data->awd_ImageGroup        = imageGroup;
 342     data->awd_ImageObject       = imageObject;
 343     data->awd_VersionObject     = versionObject;
 344     data->awd_CopyrightObject   = copyrightObject;
 345     data->awd_DescriptionGroup  = descriptionGroup;
 346     data->awd_DescriptionObject = descriptionObject;
 347     data->awd_Title             = title;
 348     data->awd_VersionNumber     = versionNumber;
 349     data->awd_VersionDate       = versionDate;
 350     data->awd_VersionExtra      = versionExtra;
 351     data->awd_Copyright         = copyright;
 352     data->awd_Description       = description;
 353
 354     if (authorsTags != NULL)  NamesToList(authorsList, authorsTags, data);
 355     if (sponsorsTags != NULL) NamesToList(sponsorsList, sponsorsTags, data);
 356
 357     /* Setup notifications */
 358     DoMethod
 359     (
 360         self, MUIM_Notify, MUIA_Window_CloseRequest, TRUE,
 361         (IPTR) self, 2, MUIA_Window_Open, FALSE
 362     );
 363
 364     return self;
 365
 366 error:
 367     if (catalog != NULL) CloseCatalog(catalog);
 368
 369     return NULL;
 370 }
 371
 372 IPTR AboutWindow__MUIM_Window_Setup
 373 (
 374     Class *CLASS, Object *self, Msg message
 375 )
 376 {
 377     struct AboutWindow_DATA *data    = INST_DATA(CLASS, self);
 378     struct Catalog          *catalog = data->awd_Catalog;
 379     STRPTR                   string  = NULL;
 380
 381     if (!DoSuperMethodA(CLASS, self, message)) return FALSE;
 382
 383     /*= Setup window title =================================================*/
 384     {
 385         STRPTR buffer = NULL;
 386         ULONG  length = 0;
 387
 388         string = data->awd_Title;
 389         if (string == NULL)
 390         {
 391             GET(self, MUIA_AboutWindow_Title, &string);
 392
 393             if (string != IGNORE)
 394             {
 395                 if (string == NULL)
 396                 {
 397                     GET(_app(self), MUIA_Application_Title, &string);
 398                 }
 399
 400                 if (string != NULL)
 401                 {
 402                     length = strlen(string) + strlen(_(MSG_ABOUT)) + 2; /* space + newline */
 403                     buffer = AllocVec(length, MEMF_ANY);
 404
 405                     if (buffer != NULL)
 406                     {
 407                         buffer[0] = '\0';
 408                         strlcat(buffer, _(MSG_ABOUT), length);
 409                         strlcat(buffer, " ", length);
 410                         strlcat(buffer, string, length);
 411
 412                         set(self, MUIA_Window_Title, buffer);
 413
 414                         FreeVec(buffer);
 415                     }
 416                 }
 417             }
 418         }
 419     }
 420
 421     /*= Setup image ========================================================*/
 422     if (data->awd_ImageObject == NULL)
 423     {
 424         DoMethod(data->awd_RootGroup, OM_REMMEMBER, (IPTR) data->awd_ImageGroup);
 425     }
 426
 427     /*= Setup version ======================================================*/
 428     /*
 429         The version string will have the format:
 430         MUIX_B"<title>"MUIX_N" <version> (<date>) [<extra>]"
 431     */
 432     {
 433         STRPTR title         = data->awd_Title,
 434                versionNumber = data->awd_VersionNumber,
 435                versionDate   = data->awd_VersionDate,
 436                versionExtra  = data->awd_VersionExtra,
 437                buffer        = NULL;
 438         ULONG  length        = 0;
 439
 440         /*- Setup default values -------------------------------------------*/
 441         if (title == NULL)
 442         {
 443             GET(_app(self), MUIA_Application_Title, &title);
 444         }
 445
 446         if (versionNumber == NULL)
 447         {
 448             GET(_app(self), MUIA_Application_Version_Number, &versionNumber);
 449         }
 450
 451         if (versionDate == NULL)
 452         {
 453             GET(_app(self), MUIA_Application_Version_Date, &versionDate);
 454         }
 455
 456         if (versionExtra == NULL)
 457         {
 458             GET(_app(self), MUIA_Application_Version_Extra, &versionExtra);
 459         }
 460
 461         /* Simplify later checks a little */
 462         if (title         == IGNORE) title         = NULL;
 463         if (versionNumber == IGNORE) versionNumber = NULL;
 464         if (versionDate   == IGNORE) versionDate   = NULL;
 465         if (versionExtra  == IGNORE) versionExtra  = NULL;
 466
 467         /*- Calculate length -----------------------------------------------*/
 468         if (title != NULL)
 469         {
 470             length += strlen(MUIX_B) + strlen(title) + strlen(MUIX_N) + 1;
 471         }
 472
 473         if (versionNumber != NULL)
 474         {
 475             length += 1 /* space */ + strlen(versionNumber);
 476         }
 477
 478         if (versionDate != NULL)
 479         {
 480             length += 1 /* space */ + 1 /* ( */ + strlen(versionDate) + 1 /* ) */;
 481         }
 482
 483         if (versionExtra != NULL)
 484         {
 485             length += 1 /* space */ + 1 /* [ */ + strlen(versionExtra) + 1 /* ] */;
 486         }
 487
 488         /*- Setup version object -------------------------------------------*/
 489         if (length > 0)
 490         {
 491             /*- Allocate memory --------------------------------------------*/
 492             buffer = AllocVec(length, MEMF_ANY);
 493
 494             if (buffer != NULL)
 495             {
 496                 buffer[0] = '\0';
 497
 498                 /*- Generate text ------------------------------------------*/
 499                 if (title != NULL)
 500                 {
 501                     strlcat(buffer, MUIX_B, length);
 502                     strlcat(buffer, title, length);
 503                     strlcat(buffer, MUIX_N, length);
 504                 }
 505
 506                 if (versionNumber != NULL)
 507                 {
 508                     strlcat(buffer, " ", length);
 509                     strlcat(buffer, versionNumber, length);
 510                 }
 511
 512                 if (versionDate != NULL)
 513                 {
 514                     strlcat(buffer, " (", length);
 515                     strlcat(buffer, versionDate, length);
 516                     strlcat(buffer, ")", length);
 517                 }
 518
 519                 if (versionExtra != NULL)
 520                 {
 521                     strlcat(buffer, " [", length);
 522                     strlcat(buffer, versionExtra, length);
 523                     strlcat(buffer, "]", length);
 524                 }
 525
 526                 set(data->awd_VersionObject, MUIA_Text_Contents, buffer);
 527                 FreeVec(buffer); /* don't need it anymore */
 528             }
 529             else
 530             {
 531                 DoMethod
 532                 (
 533                     data->awd_RootGroup, OM_REMMEMBER, (IPTR) data->awd_VersionObject
 534                 );
 535             }
 536         }
 537     }
 538
 539     /*= Setup copyright ====================================================*/
 540     if (data->awd_Copyright == NULL)
 541     {
 542         GET(_app(self), MUIA_Application_Copyright, &data->awd_Copyright);
 543     }
 544
 545     if (data->awd_Copyright != IGNORE && data->awd_Copyright != NULL)
 546     {
 547         SET(data->awd_CopyrightObject, MUIA_Text_Contents, data->awd_Copyright);
 548     }
 549     else
 550     {
 551         DoMethod(data->awd_RootGroup, OM_REMMEMBER, (IPTR) data->awd_CopyrightObject);
 552     }
 553
 554     /*= Setup description ==================================================*/
 555     if (data->awd_Description == NULL)
 556     {
 557         GET(_app(self), MUIA_Application_Description, &data->awd_Description);
 558     }
 559
 560     if (data->awd_Description != IGNORE && data->awd_Description != NULL)
 561     {
 562         SET
 563         (
 564             data->awd_DescriptionObject,
 565             MUIA_Text_Contents, data->awd_Description
 566         );
 567     }
 568     else
 569     {
 570         DoMethod
 571         (
 572             data->awd_RootGroup, OM_REMMEMBER, (IPTR) data->awd_DescriptionGroup
 573         );
 574     }
 575
 576     /* We no longer need to know whether to IGNORE or not */
 577     if (data->awd_Title == IGNORE) data->awd_Title = NULL;
 578     if (data->awd_VersionNumber == IGNORE) data->awd_VersionNumber = NULL;
 579     if (data->awd_VersionDate == IGNORE) data->awd_VersionDate = NULL;
 580     if (data->awd_VersionExtra == IGNORE) data->awd_VersionExtra = NULL;
 581     if (data->awd_Copyright == IGNORE) data->awd_Copyright = NULL;
 582     if (data->awd_Description == IGNORE) data->awd_Description = NULL;
 583
 584     return TRUE;
 585 }
 586
 587 IPTR AboutWindow__OM_DISPOSE
 588 (
 589     Class *CLASS, Object *self, Msg message
 590 )
 591 {
 592     struct AboutWindow_DATA *data   = INST_DATA(CLASS, self);
 593     UBYTE                    i;
 594     APTR                     ptrs[] =
 595     {
 596         data->awd_Title, data->awd_VersionNumber, data->awd_VersionDate,
 597         data->awd_VersionExtra, data->awd_Copyright, data->awd_VersionExtra
 598     };
 599
 600     for (i = 0; i < (sizeof(ptrs) / sizeof(APTR)); i++)
 601     {
 602         if (ptrs[i] != NULL) FreeVec(ptrs[i]);
 603     }
 604
 605     if (data->awd_Pool != NULL) DeletePool(data->awd_Pool);
 606
 607     if (data->awd_Catalog != NULL) CloseCatalog(data->awd_Catalog);
 608
 609     return DoSuperMethodA(CLASS, self, message);
 610 }