workbench/libs/datatypes/newdtobjecta.c

   1 /*
   2     Copyright © 1995-2015, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8 #include <proto/intuition.h>
   9 #include <proto/utility.h>
  10 #include <proto/iffparse.h>
  11 #include <proto/dos.h>
  12 #include <utility/tagitem.h>
  13 #include <intuition/intuition.h>
  14 #include "datatypes_intern.h"   /* Must be after <intuition/intuition.h> */
  15
  16 #include <aros/debug.h>
  17
  18 /*****************************************************************************
  19
  20     NAME */
  21 #include <proto/datatypes.h>
  22
  23         AROS_LH2(Object *, NewDTObjectA,
  24
  25 /*  SYNOPSIS */
  26         AROS_LHA(APTR            , name , D0),
  27         AROS_LHA(struct TagItem *, attrs, A0),
  28
  29 /*  LOCATION */
  30         struct Library *, DataTypesBase, 8, DataTypes)
  31
  32 /*  FUNCTION
  33
  34     Create a data type object from a BOOPSI class.
  35
  36     INPUTS
  37
  38     name   --  name of the data source; generally an existing file name
  39     attrs  --  pointer to a TagList specifying additional arguments
  40
  41     TAGS
  42
  43     DTA_SourceType  --  The type of source data (defaults to DTST_FILE).
  44                         If the source is the clipboard the name field
  45                         contains the numeric clipboard unit.
  46
  47     DTA_Handle      --  Can be used instead of the 'name' field. If the
  48                         source is DTST_FILE, ths must be a valid FileHandle;
  49                         must be a valid IFFHandle if source is DTST_CLIPBOARD.
  50
  51     DTA_DataType    --  The class of the data. Data is a pointer to a valid
  52                         DataType; only used when creating a new object that
  53                         doens't have any source data.
  54
  55     DTA_GroupID     --  If the object isn't of this type, fail with an IoErr()
  56                         of ERROR_OBJECT_WRONG_TYPE.
  57
  58     GA_Left
  59     GA_RelRight
  60     GA_Top
  61     GA_RelBottom
  62     GA_Width
  63     GA_RelWidth
  64     GA_Height
  65     GA_RelHeight    --  Specify the position of the object relative to the
  66                         window.
  67
  68     GA_ID           --  ID of the object.
  69
  70     GA_UserData     --  Application specific data for the object.
  71
  72     GA_Previous     --  Previous object / gadget in the list.
  73
  74     RESULT
  75
  76     A BOOPSI object. This may be used in different contexts such as a gadget
  77     or image. NULL indicates failure -- in that case IoErr() gives more
  78     information:
  79
  80     ERROR_REQUIRED_ARG_MISSING  --  A required attribute wasn't specified.
  81
  82     ERROR_BAD_NUMBER            --  The group ID specified was invalid.
  83
  84     ERROR_OBJECT_WRONG_TYPE     --  Object data type doesn't match DTA_GroupID.
  85
  86     NOTES
  87
  88     This function invokes the method OM_NEW for the specified class.
  89
  90     The object should (eventually) be freed by DisposeDTObject() when no
  91     longer needed.
  92
  93     EXAMPLE
  94
  95     BUGS
  96
  97     SEE ALSO
  98
  99     AddDTObject(), DisposeDTObject(), RemoveDTObject(),
 100     intuition.library/NewObjectA()
 101
 102     INTERNALS
 103
 104     HISTORY
 105
 106 *****************************************************************************/
 107 {
 108     AROS_LIBFUNC_INIT
 109
 110     ULONG             SourceType;
 111     struct DataType  *DataType;
 112     APTR              Handle;
 113     ULONG             GroupID;
 114     BPTR              lock = BNULL;
 115     struct IFFHandle *iff = NULL;
 116     Object           *dtobj = NULL;
 117     UBYTE            *BaseName = NULL;
 118     LONG             error = 0;
 119
 120     D(bug("datatypes.library/NewDTObjectA\n"));
 121
 122     if(!(SourceType = GetTagData(DTA_SourceType, DTST_FILE, attrs)))
 123     {
 124         D(bug("datatypes.library/NewDTObjectA: Bad DTA_SourceType (or no such tag)\n"));
 125         error = ERROR_REQUIRED_ARG_MISSING;
 126     }
 127     else
 128     {
 129         D(bug("datatypes.library/NewDTObjectA: DTA_SourceType okay\n"));
 130
 131         DataType = (struct DataType *)GetTagData(DTA_DataType, (IPTR) NULL, attrs);
 132         Handle   =              (APTR)GetTagData(DTA_Handle,   (IPTR) NULL, attrs);
 133         GroupID  =                    GetTagData(DTA_GroupID,         0,    attrs);
 134         BaseName =           (UBYTE *)GetTagData(DTA_BaseName, (IPTR) NULL, attrs);
 135
 136         D(bug("datatypes.library/NewDTObjectA: Got attrs DTA_DataType, DTA_Handle and DTA_GroupID\n"));
 137
 138         if((SourceType == DTST_RAM) && GroupID)
 139         {
 140             D(bug("datatypes.library/NewDTObjectA: SourceType is DTST_RAM and GroupID is != 0\n"));
 141             switch (GroupID)
 142             {
 143             case GID_ANIMATION:  BaseName="animation";         break;
 144             case GID_DOCUMENT:   BaseName="document";          break;
 145             case GID_INSTRUMENT: BaseName="instrument";        break;
 146             case GID_MOVIE:      BaseName="movie";             break;
 147             case GID_MUSIC:      BaseName="music";             break;
 148             case GID_PICTURE:    BaseName="picture";           break;
 149             case GID_SOUND:      BaseName="sound";             break;
 150             case GID_TEXT:       BaseName="ascii";             break;
 151
 152             default:             error = ERROR_BAD_NUMBER;   break;
 153             }
 154         }
 155         else
 156         {
 157             D(bug("datatypes.library/NewDTObjectA: SourceType is *not* DTST_RAM or GroupID is 0\n"));
 158
 159             if(Handle != NULL)
 160             {
 161                 D(bug("datatypes.library/NewDTObjectA: We have a DTA_Handle. Calling ObtainDataTypeA\n"));
 162
 163                 DataType = ObtainDataTypeA(SourceType, Handle, attrs);
 164
 165                 D(bug("datatypes.library/NewDTObjectA: ObtainDataTypeA() returned %x\n", DataType));
 166
 167             }
 168             else
 169             {
 170                 D(bug("datatypes.library/NewDTObjectA: DTA_Handle is NULL\n"));
 171                 if(DataType == NULL)
 172                 {
 173                     D(bug("datatypes.library/NewDTObjectA: DataType is NULL\n"));
 174
 175                     switch(SourceType)
 176                     {
 177                     case DTST_FILE:
 178                         D(bug("datatypes.library/NewDTObjectA: SourceType is DTST_FILE\n"));
 179
 180                         if((lock = Lock(name, ACCESS_READ)))
 181                         {
 182                             D(bug("datatypes.library/NewDTObjectA: Lock(\"%s\") okay\n", name));
 183                             if((DataType = ObtainDataTypeA(SourceType,
 184                                                            (APTR)lock, attrs)))
 185                             {
 186                                 D(bug("datatypes.library/NewDTObjectA: ObtainDataType returned %x\n", DataType));
 187                                 if (GroupID && (DataType->dtn_Header->dth_GroupID != GroupID))
 188                                 {
 189                                     D(bug("datatypes.library/NewDTObjectA: Bad GroupID\n"));
 190
 191                                     ReleaseDataType(DataType);
 192                                     DataType = NULL;
 193                                     error = ERROR_OBJECT_WRONG_TYPE;
 194                                 }
 195                                 else
 196                                     Handle = (APTR)lock;
 197                             }
 198
 199                             if(Handle == NULL)
 200                             {
 201                                 UnLock(lock);
 202                                 lock = BNULL;
 203                             }
 204
 205                         } /* if lock aquired */
 206                         else
 207                             error = IoErr();
 208                         break;
 209
 210                     case DTST_CLIPBOARD:
 211                         D(bug("datatypes.library/NewDTObjectA: SourceType = DTST_CLIPBOARD\n"));
 212
 213                         if(!(iff = AllocIFF()))
 214                             error = ERROR_NO_FREE_STORE;
 215                         else
 216                         {
 217                             D(bug("datatypes.library/NewDTObjectA: AllocIFF okay\n"));
 218                             if((iff->iff_Stream = (IPTR)OpenClipboard((IPTR)name)))
 219                             {
 220                                 D(bug("datatypes.library/NewDTObjectA: OpenClipBoard okay\n"));
 221
 222                                 InitIFFasClip(iff);
 223
 224                                 if(!OpenIFF(iff, IFFF_READ))
 225                                 {
 226                                     D(bug("datatypes.library/NewDTObjectA: OpenIFF okay\n"));
 227
 228                                     if((DataType = ObtainDataTypeA(SourceType,
 229                                                                   iff, attrs)))
 230                                     {
 231                                         D(bug("datatypes.library/NewDTObjectA: ObtainDataType returned %x\n", DataType));
 232
 233                                         if (GroupID && (DataType->dtn_Header->dth_GroupID != GroupID))
 234                                         {
 235                                             D(bug("datatypes.library/NewDTObjectA: Bad GroupID\n"));
 236
 237                                             ReleaseDataType(DataType);
 238                                             DataType = NULL;
 239                                             error = ERROR_OBJECT_WRONG_TYPE;
 240                                         }
 241                                         else
 242                                             Handle = iff;
 243
 244                                     } /* ObtainDataType okay */
 245                                     if(Handle == NULL)
 246                                         CloseIFF(iff);
 247
 248                                 } /* OpenIFF okay */
 249
 250                                 if(Handle == NULL)
 251                                     CloseClipboard((struct ClipboardHandle*)iff->iff_Stream);
 252
 253                             } /* OpenClipBoard okay */
 254
 255                             if(Handle == NULL)
 256                             {
 257                                 FreeIFF(iff);
 258                                 iff = NULL;
 259                             }
 260
 261                         } /* AllocIFF okay */
 262
 263                         break;
 264
 265                     } /* switch(SourceType) */
 266
 267                 } /* if (DataType == NULL */
 268
 269             } /* DTA_Handle == NULL */
 270
 271         } /* SourceType != DTST_RAM or GroupID == 0 */
 272
 273         if(DataType != NULL)
 274             BaseName = DataType->dtn_Header->dth_BaseName;
 275
 276         if(BaseName != NULL)
 277         {
 278             UBYTE libname[120];
 279             struct Library *DTClassBase;
 280
 281             D(bug("datatypes.library/NewDTObjectA: Trying OpenLibrary(datatypes/%s.datatype)\n", BaseName));
 282             strcpy(libname, "datatypes/");
 283             strcat(libname, BaseName);
 284             strcat(libname, ".datatype");
 285
 286             if(!(DTClassBase = OpenLibrary(libname, 0)))
 287                 error = DTERROR_UNKNOWN_DATATYPE;
 288             else
 289             {
 290                 struct IClass *DTClass;
 291
 292                 D(bug("datatypes.library/NewDTObjectA: OpenLibrary okay. Now calling ObtainEngine\n"));
 293
 294                 /* Call ObtainEngine() */
 295                 if((DTClass = AROS_LVO_CALL0(Class *, struct Library *,
 296                                              DTClassBase, 5,)))
 297
 298                 {
 299                     struct TagItem Tags[4];
 300
 301                     D(bug("datatypes.library/NewDTObjectA: ObtainEngine returned %x\n", DTClass));
 302
 303                     Tags[0].ti_Tag  = DTA_Name;
 304                     Tags[0].ti_Data = (IPTR)name;
 305                     Tags[1].ti_Tag  = DTA_DataType;
 306                     Tags[1].ti_Data = (IPTR)DataType;
 307                     Tags[2].ti_Tag  = DTA_Handle;
 308                     Tags[2].ti_Data = (IPTR)Handle;
 309                     Tags[3].ti_Tag  = TAG_MORE;
 310                     Tags[3].ti_Data = (IPTR)attrs;
 311
 312                     D(bug("datatypes.library/NewDTObjectA: Calling NewObjectA on obtained engine\n"));
 313
 314                     dtobj = NewObjectA(DTClass, NULL, Tags);
 315
 316                     D(bug("datatypes.library/NewDTObjectA: NewObjectA returned %x\n", dtobj));
 317
 318                     lock = BNULL;
 319                     iff = NULL;
 320
 321                 } /* ObtainEngine okay */
 322
 323                 if(dtobj == NULL)
 324                     CloseLibrary(DTClassBase);
 325
 326             } /* datatype class library could be opened */
 327
 328         } /* if (BaseName != NULL) */
 329
 330         if(dtobj == NULL)
 331         {
 332             D(bug("datatypes.library/NewDTObjectA: dtobj is NULL. Cleaning up\n"));
 333
 334             if(lock != BNULL)
 335                 UnLock(lock);
 336
 337             if(iff != NULL)
 338             {
 339                 D(bug("datatypes.library/NewDTObjectA: Calling CloseIFF\n"));
 340                 CloseIFF(iff);
 341                 D(bug("datatypes.library/NewDTObjectA: Calling CloseClipboard\n"));
 342                 CloseClipboard((struct ClipboardHandle *)iff->iff_Stream);
 343                 D(bug("datatypes.library/NewDTObjectA: Calling FreeIFF\n"));
 344                 FreeIFF(iff);
 345                 D(bug("datatypes.library/NewDTObjectA: IFF cleanup done\n"));
 346
 347             } /* if (iff != NULL) */
 348
 349         } /* if (dtobj == NULL) */
 350
 351     } /* SourceType okay */
 352
 353     if(error == ERROR_OBJECT_NOT_FOUND)
 354         error = DTERROR_COULDNT_OPEN;
 355
 356     D(bug("datatypes.library/NewDTObjectA: Done. Returning %x\n", dtobj));
 357
 358     SetIoErr(error);
 359     return dtobj;
 360
 361     AROS_LIBFUNC_EXIT
 362
 363 } /* NewDTObjectA */
 364