Index: trunk/Ohana/src/libohana/doc/libohana.html
===================================================================
--- trunk/Ohana/src/libohana/doc/libohana.html (revision 2413)
+++ trunk/Ohana/src/libohana/doc/libohana.html (revision 4810)
@@ -2,5 +2,27 @@
libohana API reference
- functions in string.c
+ ohana memory management functions
+
+ ALLOCATE (void *ptr, type, int Nalloc);
+ REALLOCATE (void *ptr, type, int Nalloc);
+ CHECK_REALLOCATE (void *ptr, type, int Nalloc, int Nused, int Ndelta);
+ free (void *ptr);
+
+ void ohana_memregister (void *ptr);
+ void ohana_memdump (int mode);
+ void ohana_memcheck (int mode);
+
+ string manipulation functions (string.c)
+
+ int get_argument (int argc, char **argv, char *arg);
+ int remove_argument (int Narg, int *argc, char **argv);
+ char *strcreate (char *string);
+ char *strncreate (char *string, int Nbytes);
+ int strnumcmp (char *str1, char *str2);
+ int stripwhite (char *string);
+ int scan_line (FILE *f, char *line);
+ int dparse (double *value, int Nentry, char *line);
+ int fparse (double *value, int Nentry, char *line);
+ char *_parse_nextword (char *string);
int get_argument (int argc, char **argv, char *arg);
@@ -10,5 +32,5 @@
- int remove_argument (int Narg, int &argc, char **argv);
+ int remove_argument (int Narg, int *argc, char **argv);
remove the given entry Narg from the argv list, adjusting argc
@@ -27,12 +49,5 @@
- char *strcreate (char *string);
- char *strncreate (char *string, int Nbytes);
- int scan_line (FILE *f, char *line);
- int dparse (double *value, int Nentry, char *line);
- int fparse (double *value, int Nentry, char *line);
- char *_parse_nextword (char *string);
-
- functions in findexec.c
+ file system functions (findexec.c)
char *pathname (char *file);
@@ -41,20 +56,15 @@
char *filebasename (char *file);
char *findexec (int argc, char **argv);
- int mkdirhier (char *path);
+ int mkdirhier (char *path);
char *getcwd_cfht (char *path, int size);
-
- functions in glockfile.c
+ void make_backup (char *filename);
+ int Fseek (FILE *f, long offset, int whence);
+
+ lockfile functions (glockfile.c)
FILE *fsetlockfile (char *filename, double timeout, int type, int *state);
- int fclearlockfile (char *filename, FILE *f, int type, int *state);
- int setlockfile2 (char *filename, double timeout, int type, int *state);
- int clearlockfile2 (char *filename, double timeout, int type, int *state);
-
- deprecated functions : are they all removed?
- int setlockfile (char *name, double timeout, int hard);
- int clearlockfile (char *name, int fd, int hard);
- int gnfsflush (char *filename);
-
- functions in Fread.c
+ int fclearlockfile (char *filename, FILE *f, int type, int *state);
+
+ read/write (Fread.c)
int Fread (char ptr, int size, int nitems, FILE *f, char *type);
@@ -63,12 +73,57 @@
int ConvertStruct (char *buffer, int size, int nitems, char *type);
- functions in LoadPhotcodes.c
-
- int LoadPhotcodes (char *filename, PhotCodeData *photcodes);
- int FreePhotcodes (PhotCodeData *photcodes);
- int GetPhotcodebyName (PhotCodeData *photcodes, char *name);
- int GetPhotcodeRefs (PhotCodeData *photcodes, char *name, int *code, int *ref);
- int GetPhotcodeEquiv (PhotCodeData *photcodes, char *name, int *code, int *ref);
- char *GetPhotnamebyCode (PhotCodeData *photcodes, int code);
+Several of these functions are used to perform byte-swapping for
+structures in the pre-autocode days. They should be deprecated and
+dropped, but the autocoding must superceed the hard-wired structure
+first.
+
+ miscellaneous functions
+
+ char *ohana_version ();
+
+ photcode manipulations (LoadPhotcodes.c)
+
+ int LoadPhotcodes (char *filename, PhotCodeData *photcodes);
+ int FreePhotcodes (PhotCodeData *photcodes);
+
+ PhotCode *GetPhotcodebyName (char *name);
+ PhotCode *GetPhotcodeEquivbyName (char *name);
+ PhotCode *GetPhotcodebyCode (int code);
+ PhotCode *GetPhotcodeEquivbyCode (int code);
+ PhotCode *GetPhotcodebyNsec (int Nsec);
+ char *GetPhotcodeNamebyCode (int code);
+
+ int GetPhotcodeCodebyName (char *name);
+ int GetPhotcodeEquivCodebyName (char *name);
+ int GetPhotcodeEquivCodebyCode (int code);
+ int GetPhotcodeNsec (int code);
+ int GetPhotcodeNsecfilt ();
+ int *GetPhotcodeEquivList (int code, int *nlist);
+
+ void SetZeroPoint (double ZP);
+ void ParseColorTerms (char *terms, float *X, int *N);
+
+ int PhotColor (Average *average, SecFilt *secfilt, Measure *measure, int c1, int c2, double *color);
+ short iPhotColor (Average *average, SecFilt *secfilt, Measure *measure, PhotCode *code);
+
+ double PhotInst (Measure *measure);
+ double PhotCat (Measure *measure);
+ double PhotSys (Measure *measure, Average *average, SecFilt *secfilt);
+ double PhotRel (Measure *measure, Average *average, SecFilt *secfilt);
+ double PhotCal (Measure *thisone, Average *average, SecFilt *secfilt, Measure *measure, PhotCode *code);
+ double PhotAve (PhotCode *code, Average *average, SecFilt *secfilt);
+ double PhotRef (PhotCode *code, Average *average, SecFilt *secfilt, Measure *measure);
+ double PhotdM (PhotCode *code, Average *average, SecFilt *secfilt);
+ double PhotXm (PhotCode *code, Average *average, SecFilt *secfilt);
+
+ short iPhotInst (Measure *measure);
+ short iPhotCat (Measure *measure);
+ short iPhotSys (Measure *measure, Average *average, SecFilt *secfilt);
+ short iPhotRel (Measure *measure, Average *average, SecFilt *secfilt);
+ short iPhotCal (Measure *thisone, Average *average, SecFilt *secfilt, Measure *measure, PhotCode *code);
+ short iPhotAve (PhotCode *code, Average *average, SecFilt *secfilt);
+ short iPhotRef (PhotCode *code, Average *average, SecFilt *secfilt, Measure *measure);
+ short iPhotdM (PhotCode *code, Average *average, SecFilt *secfilt);
+ short iPhotXm (PhotCode *code, Average *average, SecFilt *secfilt);
functions in config.c
@@ -113,6 +168,4 @@
-ALLOCATE (void *ptr, type, int Nelement)
-REALLOCATE (void *ptr, type, int Nelement)
SIGN(X)