IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Jun 1, 2006, 2:55:23 PM (20 years ago)
Author:
Paul Price
Message:

Addition of a vast quantity of assertions in public functions. Adopted a policy of using assert() within file-static functions (since they are only called internally, any errors there are problems with the program) and using the PS_ASSERT_WHATEVER() macros within public functions. Cleaned a few things up in the process.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/psModules/src/camera/pmFPAfile.c

    r7249 r7278  
    2222#include "pmFPA_JPEG.h"
    2323
    24 static void pmFPAfileFree (pmFPAfile *file)
    25 {
    26 
    27     if (file == NULL)
     24static void pmFPAfileFree(pmFPAfile *file)
     25{
     26    if (!file) {
    2827        return;
     28    }
    2929
    3030    psFree (file->fpa);
    … …  
    5454}
    5555
    56 pmFPAfile *pmFPAfileAlloc ()
    57 {
    58 
    59     pmFPAfile *file = psAlloc (sizeof(pmFPAfile));
    60     psMemSetDeallocator (file, (psFreeFunc) pmFPAfileFree);
     56pmFPAfile *pmFPAfileAlloc()
     57{
     58    pmFPAfile *file = psAlloc(sizeof(pmFPAfile));
     59    psMemSetDeallocator(file, (psFreeFunc) pmFPAfileFree);
    6160
    6261    file->phu = NULL;
    … …  
    8382    file->state = PM_FPA_STATE_CLOSED;
    8483
    85     return (file);
    86 }
    87 
    88 pmFPAfile *pmFPAfileDefine (psMetadata *files, psMetadata *camera, pmFPA *fpa, char *name)
    89 {
     84    return file;
     85}
     86
     87pmFPAfile *pmFPAfileDefine(psMetadata *files, psMetadata *camera, pmFPA *fpa, char *name)
     88{
     89    PS_ASSERT_PTR_NON_NULL(files, NULL);
     90    PS_ASSERT_PTR_NON_NULL(camera, NULL);
     91    PS_ASSERT_PTR_NON_NULL(fpa, NULL);
     92    PS_ASSERT_PTR_NON_NULL(name, NULL);
     93    PS_ASSERT_INT_POSITIVE(strlen(name), NULL);
    9094
    9195    bool status;
    … …  
    243247bool pmFPAfileOpen (pmFPAfile *file, const pmFPAview *view)
    244248{
     249    PS_ASSERT_PTR_NON_NULL(file, false);
     250    PS_ASSERT_PTR_NON_NULL(view, false);
    245251
    246252    bool status;
    … …  
    325331}
    326332
    327 bool pmFPAfileRead (pmFPAfile *file, const pmFPAview *view)
    328 {
     333bool pmFPAfileRead(pmFPAfile *file, const pmFPAview *view)
     334{
     335    PS_ASSERT_PTR_NON_NULL(file, false);
     336    PS_ASSERT_PTR_NON_NULL(view, false);
     337
    329338    if (file->state & PM_FPA_STATE_INACTIVE)
    330339        return false;
    … …  
    378387}
    379388
    380 bool pmFPAfileWrite (pmFPAfile *file, const pmFPAview *view)
    381 {
     389bool pmFPAfileWrite(pmFPAfile *file, const pmFPAview *view)
     390{
     391    PS_ASSERT_PTR_NON_NULL(file, false);
     392    PS_ASSERT_PTR_NON_NULL(view, false);
    382393
    383394    if (file->state & PM_FPA_STATE_INACTIVE) {
    … …  
    436447bool pmFPAfileCreate (pmFPAfile *file, const pmFPAview *view)
    437448{
     449    PS_ASSERT_PTR_NON_NULL(file, false);
     450    PS_ASSERT_PTR_NON_NULL(view, false);
     451
    438452    if (file->state & PM_FPA_STATE_INACTIVE) {
    439453        return false;
    … …  
    478492bool pmFPAfileClose (pmFPAfile *file, const pmFPAview *view)
    479493{
     494    PS_ASSERT_PTR_NON_NULL(file, false);
     495    PS_ASSERT_PTR_NON_NULL(view, false);
     496
    480497    if (file->state & PM_FPA_STATE_INACTIVE) {
    481498        return false;
    … …  
    524541bool pmFPAfileActivate (psMetadata *files, bool state, char *name)
    525542{
    526     if (name == NULL) {
     543    PS_ASSERT_PTR_NON_NULL(files, false);
     544
     545    if (!name) {
    527546        psMetadataItem *item = NULL;
    528547        psMetadataIterator *iter = psMetadataIteratorAlloc (files, PS_LIST_HEAD, NULL);
    … …  
    555574bool pmFPAfileIOChecks (psMetadata *files, const pmFPAview *view, pmFPAfilePlace place)
    556575{
     576    PS_ASSERT_PTR_NON_NULL(files, false);
     577    PS_ASSERT_PTR_NON_NULL(view, false);
     578
    557579    // recipe override values (command-line options):
    558580    psMetadataItem *item = NULL;
    … …  
    577599pmReadout *pmFPAfileCreateInternal (psMetadata *files, char *name, int Nx, int Ny, int type)
    578600{
    579     pmReadout *readout = pmReadoutAlloc (NULL);
    580     readout->image = psImageAlloc (Nx, Ny, type);
     601    PS_ASSERT_PTR_NON_NULL(files, false);
     602    PS_ASSERT_PTR_NON_NULL(name, false);
     603    PS_ASSERT_INT_POSITIVE(strlen(name), false);
     604
     605    pmReadout *readout = pmReadoutAlloc(NULL);
     606    readout->image = psImageAlloc(Nx, Ny, type);
    581607
    582608    // I want an image from the
    … …  
    585611
    586612    file->readout = readout;
    587     psMetadataAddPtr (files, PS_LIST_TAIL, name, PS_DATA_UNKNOWN, "", file);
    588     psFree (file);
     613    psMetadataAddPtr(files, PS_LIST_TAIL, name, PS_DATA_UNKNOWN, "", file);
     614    psFree(file);
    589615    // we free this copy of file, but 'files' still has a copy
    590616
    591     return (readout);
    592 }
    593 
    594 bool pmFPAfileDropInternal (psMetadata *files, char *name)
    595 {
     617    return readout;
     618}
     619
     620bool pmFPAfileDropInternal(psMetadata *files, char *name)
     621{
     622    PS_ASSERT_PTR_NON_NULL(files, false);
     623    PS_ASSERT_PTR_NON_NULL(name, false);
     624    PS_ASSERT_INT_POSITIVE(strlen(name), false);
     625
    596626    bool status;
    597627
    … …  
    610640pmReadout *pmFPAfileThisReadout (psMetadata *files, const pmFPAview *view, const char *name)
    611641{
     642    PS_ASSERT_PTR_NON_NULL(files, false);
     643    PS_ASSERT_PTR_NON_NULL(view, false);
     644    PS_ASSERT_PTR_NON_NULL(name, false);
     645    PS_ASSERT_INT_POSITIVE(strlen(name), false);
     646
    612647    bool status;
    613648
    … …  
    629664bool pmFPAviewReadFitsImage (const pmFPAview *view, pmFPAfile *file)
    630665{
     666    PS_ASSERT_PTR_NON_NULL(view, false);
     667    PS_ASSERT_PTR_NON_NULL(file, false);
     668
    631669    bool status;
    632670    pmFPA *fpa = file->fpa;
    … …  
    680718bool pmFPAviewWriteFitsImage (const pmFPAview *view, pmFPAfile *file)
    681719{
     720    PS_ASSERT_PTR_NON_NULL(view, false);
     721    PS_ASSERT_PTR_NON_NULL(file, false);
    682722
    683723    pmFPA *fpa = file->fpa;
    … …  
    748788pmFPAfile *pmFPAfileFromArgs (bool *found, pmConfig *config, char *filename, char *argname)
    749789{
     790    PS_ASSERT_PTR_NON_NULL(config, false);
     791    PS_ASSERT_PTR_NON_NULL(filename, false);
     792    PS_ASSERT_INT_POSITIVE(strlen(filename), false);
     793    PS_ASSERT_PTR_NON_NULL(argname, false);
     794    PS_ASSERT_INT_POSITIVE(strlen(argname), false);
     795
    750796    bool status;
    751797    pmFPA *fpa = NULL;
    … …  
    755801    psMetadata *format = NULL;
    756802
    757     if (*found)
    758         return NULL;
     803    if (*found) {
     804        return NULL;
     805    }
    759806
    760807    // we search the argument data for the named fileset (argname)
    761808    psArray *infiles = psMetadataLookupPtr(&status, config->arguments, argname);
    762     if (!status)
    763         return NULL;
    764     if (infiles->n < 1)
    765         return NULL;
     809    if (!status) {
     810        return NULL;
     811    }
     812    if (infiles->n < 1) {
     813        return NULL;
     814    }
    766815
    767816    // determine the current format from the header
    … …  
    836885pmFPAfile *pmFPAfileSetFromArgs (bool *found, pmConfig *config, char *filename, char *argname)
    837886{
     887    PS_ASSERT_PTR_NON_NULL(config, false);
     888    PS_ASSERT_PTR_NON_NULL(filename, false);
     889    PS_ASSERT_INT_POSITIVE(strlen(filename), false);
     890    PS_ASSERT_PTR_NON_NULL(argname, false);
     891    PS_ASSERT_INT_POSITIVE(strlen(argname), false);
     892
    838893    bool status;
    839894    pmFPA *fpa = NULL;
    … …  
    848903    // we search the argument data for the named fileset (argname)
    849904    psArray *infiles = psMetadataLookupPtr(&status, config->arguments, argname);
    850     if (!status)
    851         return NULL;
    852     if (infiles->n < 1)
    853         return NULL;
     905    if (!status) {
     906        return NULL;
     907    }
     908    if (infiles->n < 1) {
     909        return NULL;
     910    }
    854911
    855912    // determine the current format from the header
    … …  
    914971pmFPAfile *pmFPAfileFromFPA (pmConfig *config, pmFPA *src, int xBin, int yBin, char *filename)
    915972{
     973    PS_ASSERT_PTR_NON_NULL(config, false);
     974    PS_ASSERT_PTR_NON_NULL(src, false);
     975    PS_ASSERT_PTR_NON_NULL(filename, false);
     976    PS_ASSERT_INT_POSITIVE(strlen(filename), false);
     977
    916978    // XXX pmFPAConstruct has many leaks (6919)
    917979    pmFPA *fpa = pmFPAConstruct (config->camera);
    … …  
    928990pmFPAfile *pmFPAfileFromConf (bool *found, pmConfig *config, char *filename, pmFPA *input)
    929991{
     992    PS_ASSERT_PTR_NON_NULL(config, false);
     993    PS_ASSERT_PTR_NON_NULL(filename, false);
     994    PS_ASSERT_INT_POSITIVE(strlen(filename), false);
     995    PS_ASSERT_PTR_NON_NULL(input, false);
     996
    930997    psFits *fits = NULL;
    931998    pmFPAfile *file = NULL;
    … …  
    9341001    psArray *infiles = NULL;
    9351002
    936     if (*found)
    937         return NULL;
     1003    if (*found) {
     1004        return NULL;
     1005    }
    9381006
    9391007    // a camera config is needed (as source of file rule)
    … …  
    9511019
    9521020    // image names come from the file->name list?
    953     if (!strcasecmp (file->filerule, "@FILES"))
     1021    if (!strcasecmp (file->filerule, "@FILES")) {
    9541022        psAbort ("pmFPAfileFromConfig", "programming error");
     1023    }
    9551024
    9561025    // image needs to come from the detrend database
    … …  
    9641033        infiles->data[0] = psStringCopy (file->filerule);
    9651034    }
    966     if (infiles == NULL)
    967         return NULL;
     1035    if (infiles == NULL) {
     1036        return NULL;
     1037    }
    9681038    if (infiles->n < 1) {
    9691039        psFree (infiles);
    … …  
    10181088bool pmFPAfileAddFileNames (psMetadata *files, char *name, char *value, int mode)
    10191089{
     1090    PS_ASSERT_PTR_NON_NULL(files, false);
     1091    PS_ASSERT_PTR_NON_NULL(name, false);
     1092    PS_ASSERT_INT_POSITIVE(strlen(name), false);
     1093    PS_ASSERT_PTR_NON_NULL(value, false);
     1094    PS_ASSERT_INT_POSITIVE(strlen(value), false);
    10201095
    10211096    // add the output names to the output-type files
    … …  
    10361111char *pmFPAfileNameFromRule (char *rule, pmFPAfile *file, const pmFPAview *view)
    10371112{
     1113    PS_ASSERT_PTR_NON_NULL(rule, NULL);
     1114    PS_ASSERT_INT_POSITIVE(strlen(rule), NULL);
     1115    PS_ASSERT_PTR_NON_NULL(file, NULL);
     1116    PS_ASSERT_PTR_NON_NULL(view, NULL);
    10381117
    10391118    char *newName = NULL;     // destination for resulting name
    … …  
    10781157bool pmFPAfileCopyView (pmFPA *out, pmFPA *in, const pmFPAview *view)
    10791158{
     1159    PS_ASSERT_PTR_NON_NULL(out, false);
     1160    PS_ASSERT_PTR_NON_NULL(in, false);
     1161    PS_ASSERT_PTR_NON_NULL(view, false);
     1162
    10801163    // pmFPAWrite takes care of all PHUs as needed
    10811164    if (view->chip == -1) {
    … …  
    11121195bool pmFPAfileCopyStructureView (pmFPA *out, pmFPA *in, psMetadata *format, int xBin, int yBin, const pmFPAview *view)
    11131196{
     1197    PS_ASSERT_PTR_NON_NULL(out, false);
     1198    PS_ASSERT_PTR_NON_NULL(in, false);
     1199    PS_ASSERT_PTR_NON_NULL(format, false);
     1200    PS_ASSERT_PTR_NON_NULL(view, false);
     1201
    11141202    // pmFPAWrite takes care of all PHUs as needed
    11151203    if (view->chip == -1) {
Note: See TracChangeset for help on using the changeset viewer.