workbench/libs/icon/geticontaglist.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include <aros/debug.h>
   7 #include <workbench/icon.h>
   8
   9 #include "icon_intern.h"
  10 #include "support.h"
  11 #include "support_builtin.h"
  12 #include "identify.h"
  13
  14 /*****************************************************************************
  15
  16     NAME */
  17 #include <proto/icon.h>
  18
  19         AROS_LH2(struct DiskObject *, GetIconTagList,
  20
  21 /*  SYNOPSIS */
  22         AROS_LHA(CONST_STRPTR, name, A0),
  23         AROS_LHA(struct TagItem *, tags, A1),
  24 /*  LOCATION */
  25         struct IconBase *, IconBase, 30, Icon)
  26
  27 /*  FUNCTION
  28         Opens an icon from disk.
  29
  30     INPUTS
  31         name - object path (without .info extension). May be NULL when
  32             retrieving a default icon.
  33         tags - tag list containing tags described below.
  34
  35     TAGS
  36         ICONA_ErrorCode (LONG *)
  37         ICONGETA_GetDefaultType (LONG) - Default icon type to get. This
  38                 overrides the "name" parameter.
  39         ICONGETA_GetDefaultName (STRPTR) - Name of default icon to get. This
  40                 overrides the "name" parameter.
  41         ICONGETA_FailIfUnavailable (BOOL) - Find a default icon if there is no
  42                 specific icon.
  43         ICONGETA_GetPaletteMappedIcon (BOOL)
  44         ICONGETA_IsDefaultIcon (LONG *) - Upon completion of this function, the
  45             referenced LONG will be set to a boolean value indicating whether
  46             the returned icon is a default icon.
  47         ICONGETA_RemapIcon (BOOL)
  48         ICONGETA_GenerateImageMasks (BOOL)
  49         ICONGETA_Label (STRPTR)
  50         ICONGETA_Screen (struct Screen *)
  51
  52     RESULT
  53
  54     NOTES
  55
  56     EXAMPLE
  57
  58     BUGS
  59
  60     SEE ALSO
  61
  62     INTERNALS
  63
  64 *****************************************************************************/
  65 {
  66     AROS_LIBFUNC_INIT
  67
  68     struct TagItem       *tstate            = (struct TagItem *)tags;
  69     struct TagItem *tag;
  70     struct DiskObject    *icon              = NULL;
  71     LONG                  defaultType       = -1;
  72     CONST_STRPTR          defaultName       = NULL;
  73     IPTR                  failIfUnavailable = TRUE;
  74     LONG                 *isDefaultIcon     = NULL;
  75
  76     IPTR                  getPaletteMappedIcon = TRUE;
  77     IPTR                  remapIcon            = TRUE;
  78     IPTR                  generateImageMasks   = TRUE;
  79     struct Screen        *screen               = NULL;
  80     STRPTR                label                = NULL; // FIXME: not used
  81     LONG                 error                 = 0;
  82     LONG                 *errorCode            = NULL;
  83
  84 #   define SET_ISDEFAULTICON(value) (isDefaultIcon != NULL ? *isDefaultIcon = (value) : (value))
  85
  86     D(bug("[%s] name %s, tags %p\n", __func__, name, tags));
  87
  88     /* Parse taglist -------------------------------------------------------*/
  89     while ((tag = NextTagItem(&tstate)) != NULL)
  90     {
  91         switch (tag->ti_Tag)
  92         {
  93             case ICONGETA_GetDefaultType:
  94                 if (defaultType == -1)
  95                     defaultType = tag->ti_Data;
  96                 break;
  97
  98             case ICONGETA_GetDefaultName:
  99                 if (defaultName == NULL)
 100                     defaultName = (CONST_STRPTR) tag->ti_Data;
 101                 break;
 102
 103             case ICONGETA_FailIfUnavailable:
 104                 failIfUnavailable = tag->ti_Data;
 105                 break;
 106
 107             case ICONGETA_IsDefaultIcon:
 108                 isDefaultIcon  = (LONG *) tag->ti_Data;
 109                 SET_ISDEFAULTICON(FALSE);
 110                 break;
 111
 112             case ICONGETA_GetPaletteMappedIcon:
 113                 getPaletteMappedIcon = tag->ti_Data;
 114                 break;
 115
 116             case ICONGETA_RemapIcon:
 117                 remapIcon = tag->ti_Data;
 118                 break;
 119
 120             case ICONGETA_GenerateImageMasks:
 121                 generateImageMasks = tag->ti_Data;
 122                 break;
 123
 124             case ICONGETA_Screen:
 125                 screen = (struct Screen *) tag->ti_Data;
 126                 break;
 127
 128             case ICONGETA_Label:
 129                 label = (STRPTR) tag->ti_Data;
 130                 break;
 131
 132             case ICONA_ErrorCode:
 133                 errorCode = (LONG *) tag->ti_Data;
 134                 break;
 135         }
 136     }
 137
 138     if (defaultType != -1 || defaultName != NULL)
 139     {
 140         if (defaultName != NULL)
 141         {
 142             BPTR file = OpenDefaultIcon(defaultName, MODE_OLDFILE);
 143
 144             D(bug("[%s] Find default icon '%s'\n", __func__, defaultName));
 145             if (file != BNULL)
 146             {
 147                 D(bug("[%s] Found default icon '%s'\n", __func__, defaultName));
 148                 icon = ReadIcon(file);
 149                 CloseDefaultIcon(file);
 150                 SET_ISDEFAULTICON(TRUE);
 151             }
 152         }
 153
 154         if (icon == NULL && defaultType != -1 && defaultName == NULL)
 155         {
 156             CONST_STRPTR defaultIconName = GetDefaultIconName(defaultType);
 157
 158             D(bug("[%s] Find default icon type %d\n", __func__, defaultType));
 159             if (defaultIconName != NULL)
 160             {
 161                 icon = GetIconTags
 162                 (
 163                     NULL,
 164                     ICONGETA_GetDefaultName, (IPTR) defaultIconName,
 165                     TAG_END
 166                 );
 167                 D(bug("[%s] Find default icon type %d as %p\n", __func__, defaultType, icon));
 168
 169                 if (icon == NULL)
 170                 {
 171                     icon = GetBuiltinIcon(defaultType);
 172                     D(bug("[%s] Using builtin icon %p\n", __func__, icon));
 173                     SET_ISDEFAULTICON(TRUE);
 174                 }
 175             }
 176         }
 177     }
 178     else if (name != NULL)
 179     {
 180         BPTR file = OpenIcon(name, MODE_OLDFILE);
 181
 182         D(bug("[%s] Find custom icon '%s'\n", __func__, name));
 183         if (file != BNULL)
 184         {
 185             D(bug("[%s] Found custom icon '%s'\n", __func__, name));
 186             icon = ReadIcon(file);
 187             CloseIcon(file);
 188
 189             if (icon != NULL && icon->do_Type == 0)
 190             {
 191                 /* Force the icon type */
 192                 BPTR lock = LockObject(name, ACCESS_READ);
 193                 if (lock != BNULL)
 194                 {
 195                     LONG type = FindType(lock);
 196                     if (type != -1) icon->do_Type = type;
 197
 198                     UnLockObject(lock);
 199                 }
 200             }
 201
 202             /*
 203              * If everything else fails, just lie. Not having do_Type set
 204              * causes problems.
 205              */
 206             if (icon != NULL && icon->do_Type == 0)
 207                 icon->do_Type = WBPROJECT;
 208         }
 209     } else {
 210         /* NULL name = return empty DiskObject */
 211         D(bug("[%s] Get an empty DiskObject\n", __func__));
 212         icon = NewDiskObject(0);
 213     }
 214
 215     /* Try to identify it by name or type */
 216     if (icon == NULL && !failIfUnavailable)
 217     {
 218         struct IconIdentifyMsg iim;
 219
 220         D(bug("[%s] Falling back to default icon for %s\n", __func__, name));
 221
 222         if (name && (iim.iim_FileLock = LockObject(name, ACCESS_READ)) != BNULL)
 223         {
 224             D(bug("[%s] Locked %s, identifying\n", __func__, name));
 225             if ((iim.iim_FIB = AllocDosObject(DOS_FIB, TAG_DONE)) != NULL)
 226             {
 227                 if (Examine(iim.iim_FileLock, iim.iim_FIB))
 228                 {
 229                     iim.iim_SysBase     = (struct Library *) SysBase;
 230                     iim.iim_DOSBase     = (struct Library *) DOSBase;
 231                     iim.iim_UtilityBase = (struct Library *) UtilityBase;
 232                     iim.iim_IconBase    = (struct Library *) IconBase;
 233                     iim.iim_Tags        = tags;
 234
 235                     iim.iim_ParentLock  = ParentDir(iim.iim_FileLock);
 236                     if (iim.iim_ParentLock == BNULL && IoErr() == 0)
 237                         iim.iim_FIB->fib_DirEntryType = ST_ROOT;
 238                     iim.iim_FileHandle  = Open(name, MODE_OLDFILE);
 239
 240                     if (LB(IconBase)->ib_IdentifyHook != NULL)
 241                     {
 242                         /* Use user-provided identify hook */
 243                         icon = (struct DiskObject *) CALLHOOKPKT
 244                         (
 245                             LB(IconBase)->ib_IdentifyHook, NULL, &iim
 246                         );
 247
 248                         if (icon != NULL)
 249                         {
 250                             /*
 251                                 Sanity check since we don't trust the
 252                                 user-provided hook too much. ;-)
 253                             */
 254
 255                             LONG type = FindType(iim.iim_FileLock);
 256                             if (type != -1) icon->do_Type = type;
 257                         }
 258                     }
 259
 260                     if (icon == NULL)
 261                     {
 262                         /* Fall back to the default identify function */
 263                         D(bug("[%s] Finding default icon for iim %p\n", __func__, &iim));
 264                         icon = FindDefaultIcon(&iim);
 265                     }
 266
 267                     if (iim.iim_ParentLock != BNULL) UnLock(iim.iim_ParentLock);
 268                     if (iim.iim_FileHandle != BNULL) Close(iim.iim_FileHandle);
 269                 }
 270
 271                 FreeDosObject(DOS_FIB, iim.iim_FIB);
 272             }
 273             else
 274             {
 275                 error = IoErr();
 276             }
 277
 278             UnLockObject(iim.iim_FileLock);
 279         }
 280
 281         if (icon == NULL && defaultType > 0) {
 282             icon = GetBuiltinIcon(defaultType);
 283             D(bug("[%s] Using builtin icon %p\n", __func__, icon));
 284         }
 285
 286         if (icon == NULL) {
 287             LONG type = (name && Stricmp("Disk", name)==0) ? WBDISK : WBPROJECT;
 288             icon = GetBuiltinIcon(type);
 289             D(bug("[%s] Using builtin icon %p, type %d\n",  __func__, icon, type));
 290         }
 291     }
 292
 293
 294     if (!icon)
 295         goto exit;
 296
 297     if (label != NULL) {
 298         /* TODO: Add the label specified in 'label' to the icon */
 299     }
 300
 301     if (generateImageMasks) {
 302         D(bug("[%s] %p: Generate image masks\n", __func__, icon));
 303         /* A side effect of palette mapping the icon... */
 304         getPaletteMappedIcon = TRUE;
 305     }
 306
 307     if (getPaletteMappedIcon) {
 308         D(bug("[%s] %p: Generate palette mapped icon\n", __func__, icon));
 309         /* A side effect of remapping the icon to the DefaultPubScreen */
 310         remapIcon = TRUE;
 311     }
 312
 313     if (remapIcon) {
 314         if (screen == NULL)
 315             IconControl(NULL, ICONCTRLA_GetGlobalScreen, &screen, TAG_END);
 316     } else {
 317         screen = NULL;
 318     }
 319
 320     /* Any last-minute fixups */
 321     PrepareIcon(icon);
 322
 323     D(bug("[%s] %p: Performing initial layout for screen %p\n", __func__, icon, screen));
 324     LayoutIconA(icon, screen, (struct TagItem *)tags);
 325
 326 exit:
 327     /* Set error code */
 328     if (errorCode != NULL)
 329         *errorCode = error;
 330     SetIoErr(error);
 331
 332     D(bug("[%s] name %s, tags %p => %p\n", __func__, name, tags, icon));
 333
 334     return icon;
 335
 336     AROS_LIBFUNC_EXIT
 337
 338 #   undef SET_ISDEFAULTICON
 339
 340 } /* GetIconTagList() */