/[MITgcm]/MITgcm/tools/mpack-1.6/macICAPI.h
ViewVC logotype

Contents of /MITgcm/tools/mpack-1.6/macICAPI.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.1 - (show annotations) (download)
Tue Aug 26 20:45:25 2003 UTC (20 years, 7 months ago) by edhill
Branch: MAIN
CVS Tags: checkpoint64y, checkpoint64x, checkpoint58l_post, checkpoint64z, checkpoint51k_post, checkpoint57t_post, checkpoint64q, checkpoint64p, checkpoint64s, checkpoint64r, checkpoint64u, checkpoint64t, checkpoint64w, checkpoint64v, checkpoint64i, checkpoint64h, checkpoint64k, checkpoint64j, checkpoint64m, checkpoint64l, checkpoint64o, checkpoint64n, checkpoint64a, checkpoint57o_post, checkpoint64c, checkpoint64b, checkpoint64e, checkpoint64d, checkpoint64g, checkpoint64f, checkpoint52l_pre, checkpoint52e_pre, hrcube4, checkpoint58e_post, mitgcm_mapl_00, checkpoint52n_post, checkpoint52j_post, checkpoint53d_post, checkpoint58u_post, checkpoint58w_post, checkpoint54a_pre, checkpoint51o_pre, checkpoint57m_post, checkpoint55c_post, checkpoint54e_post, checkpoint52e_post, checkpoint57s_post, checkpoint51n_pre, checkpoint54a_post, checkpoint63p, checkpoint63q, checkpoint63r, checkpoint63s, checkpoint63l, checkpoint63m, checkpoint63n, checkpoint63o, checkpoint63h, checkpoint63i, checkpoint63j, checkpoint63k, checkpoint63d, checkpoint63e, checkpoint63f, checkpoint63g, checkpoint53c_post, checkpoint63a, checkpoint63b, checkpoint63c, checkpoint57k_post, checkpoint55d_pre, checkpoint57d_post, checkpoint51l_post, checkpoint57g_post, checkpoint51q_post, checkpoint64, checkpoint65, checkpoint60, checkpoint61, checkpoint62, checkpoint63, checkpoint57b_post, checkpoint57c_pre, checkpoint51j_post, checkpoint58r_post, checkpoint55j_post, checkpoint56b_post, checkpoint57i_post, checkpoint57y_post, hrcube_1, checkpoint57e_post, checkpoint66g, checkpoint66f, checkpoint66e, checkpoint66d, checkpoint66c, checkpoint66b, checkpoint66a, checkpoint66o, checkpoint66n, checkpoint66m, checkpoint66l, checkpoint66k, checkpoint66j, checkpoint66i, checkpoint66h, branch-netcdf, checkpoint52d_pre, checkpoint52l_post, checkpoint55h_post, checkpoint58n_post, checkpoint53b_post, checkpoint58x_post, checkpoint52k_post, checkpoint52b_pre, checkpoint57g_pre, checkpoint54b_post, checkpoint53b_pre, checkpoint55b_post, checkpoint58t_post, checkpoint58h_post, checkpoint65z, checkpoint65x, checkpoint65y, checkpoint54d_post, checkpoint65r, checkpoint65s, checkpoint65p, checkpoint65q, checkpoint65v, checkpoint65w, checkpoint65t, checkpoint65u, checkpoint65j, checkpoint65k, checkpoint65h, checkpoint65i, checkpoint65n, checkpoint65o, checkpoint65l, checkpoint65m, checkpoint65b, checkpoint65c, checkpoint65a, checkpoint65f, checkpoint65g, checkpoint65d, checkpoint65e, checkpoint56c_post, checkpoint52m_post, checkpoint57y_pre, checkpoint55, checkpoint53a_post, checkpoint57f_pre, checkpoint57a_post, checkpoint54, checkpoint58q_post, checkpoint54f_post, checkpoint57v_post, checkpoint59q, checkpoint59p, checkpoint55g_post, checkpoint59r, checkpoint51o_post, checkpoint51p_post, checkpoint58j_post, checkpoint52a_pre, checkpoint59e, checkpoint59d, checkpoint59g, checkpoint59f, checkpoint59a, checkpoint55f_post, checkpoint59c, checkpoint59b, checkpoint59m, checkpoint59l, checkpoint59o, checkpoint59n, checkpoint59i, checkpoint59h, checkpoint59k, checkpoint59j, checkpoint57r_post, checkpoint59, checkpoint58, checkpoint57a_pre, checkpoint55i_post, checkpoint57, checkpoint56, checkpoint51i_post, checkpoint53, checkpoint52, checkpoint51f_post, checkpoint52d_post, eckpoint57e_pre, checkpoint51r_post, checkpoint52a_post, checkpoint57h_done, checkpoint58f_post, checkpoint52b_post, checkpoint53g_post, checkpoint52f_post, branchpoint-genmake2, checkpoint57x_post, checkpoint57n_post, checkpoint52c_post, checkpoint58d_post, checkpoint58c_post, checkpoint57w_post, checkpoint57p_post, checkpint57u_post, checkpoint57f_post, checkpoint58a_post, checkpoint51h_pre, checkpoint51l_pre, checkpoint58i_post, checkpoint57q_post, checkpoint51g_post, checkpoint58g_post, ecco_c52_e35, hrcube5, checkpoint58o_post, checkpoint57z_post, checkpoint62c, checkpoint62b, checkpoint62a, checkpoint62g, checkpoint62f, checkpoint62e, checkpoint62d, checkpoint62k, checkpoint62j, checkpoint62i, checkpoint62h, checkpoint62o, checkpoint62n, checkpoint62m, checkpoint62l, checkpoint62s, checkpoint62r, checkpoint62q, checkpoint62p, checkpoint62w, checkpoint62v, checkpoint62u, checkpoint62t, checkpoint57c_post, checkpoint62z, checkpoint62y, checkpoint62x, checkpoint58y_post, checkpoint55e_post, checkpoint58k_post, checkpoint52i_post, checkpoint52j_pre, checkpoint58v_post, checkpoint53f_post, checkpoint55a_post, checkpoint51t_post, checkpoint53d_pre, checkpoint54c_post, checkpoint58s_post, checkpoint61f, checkpoint61g, checkpoint61d, checkpoint61e, checkpoint61b, checkpoint61c, checkpoint58p_post, checkpoint61a, checkpoint61n, checkpoint61o, checkpoint61l, checkpoint61m, checkpoint61j, checkpoint61k, checkpoint61h, checkpoint61i, checkpoint61v, checkpoint61w, checkpoint61t, checkpoint61u, checkpoint61r, checkpoint61s, checkpoint61p, checkpoint61q, checkpoint51n_post, checkpoint57j_post, checkpoint61z, checkpoint61x, checkpoint61y, checkpoint58b_post, checkpoint57h_pre, checkpoint51i_pre, checkpoint58m_post, checkpoint57l_post, checkpoint52i_pre, checkpoint51u_post, checkpoint52h_pre, checkpoint52f_pre, checkpoint57h_post, hrcube_2, hrcube_3, checkpoint56a_post, checkpoint51m_post, checkpoint51s_post, checkpoint55d_post, HEAD
Branch point for: branch-nonh, branch-genmake2, tg2-branch, checkpoint51n_branch, netcdf-sm0
File MIME type: text/plain
Initial check-in of the CMU "mpack" utility.  This allows us to (portably)
send MITgcm output as MIME-encoded email messages and will be used by the
"testreport" script.  The CMU license is basically an "AS-IS" statement.

1 /* (C) Copyright 1995 by Carnegie Mellon University
2 * All Rights Reserved.
3 *
4 * Permission to use, copy, modify, distribute, and sell this software
5 * and its documentation for any purpose is hereby granted without
6 * fee, provided that the above copyright notice appear in all copies
7 * and that both that copyright notice and this permission notice
8 * appear in supporting documentation, and that the name of Carnegie
9 * Mellon University not be used in advertising or publicity
10 * pertaining to distribution of the software without specific,
11 * written prior permission. Carnegie Mellon University makes no
12 * representations about the suitability of this software for any
13 * purpose. It is provided "as is" without express or implied
14 * warranty.
15 *
16 * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
17 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
18 * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
19 * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
20 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
21 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
22 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
23 * SOFTWARE.
24 */
25 /*
26 The canonical Internet Config interface is defined in Pascal. These headers have
27 not been thoroughly tested. If there is a conflict between these headers and the
28 Pascal interfaces, the Pascal should take precedence.
29 */
30
31 /* ///////////////////////////////////////////////////////////////////////////////// */
32
33 #ifndef __ICAPI__
34 #define __ICAPI__
35
36 #ifndef __TYPES__
37 #include <Types.h>
38 #endif
39
40 #ifndef __FILES__
41 #include <Files.h>
42 #endif
43
44 #ifndef __ICTYPES__
45 #include <ICTypes.h>
46 #endif
47
48 /* ///////////////////////////////////////////////////////////////////////////////// */
49
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53
54 pascal ICError ICStart(ICInstance *inst, OSType creator);
55 /* call at application initialisation */
56
57 pascal ICError ICStop(ICInstance inst);
58 /* call at application termination */
59
60 pascal ICError ICFindConfigFile(ICInstance inst, short count, ICDirSpecArrayPtr folders);
61 /* count is the number of ICDirSpecs that are valid in folders */
62 /* searches the specified folders first, then backs out to preferences folder */
63 /* don't you worry about how it finds the file (; */
64 /* you can pass nil to folders if count is 0 */
65
66 pascal ICError ICSpecifyConfigFile(ICInstance inst, FSSpec *config);
67 /* for use *only* by Internet Configuration application */
68
69 pascal ICError ICGetSeed(ICInstance inst, long *seed);
70 /* returns current seed for prefs file */
71 /* this seed changes every time a preference is modified */
72 /* poll this to detect preference changes by other applications */
73
74 pascal ICError ICGetPerm(ICInstance inst, ICPerm *perm);
75 /* returns the permissions currently associated with this file */
76 /* mainly used by overriding components, applications normally */
77 /* know what permissions they have */
78
79 pascal ICError ICBegin(ICInstance inst, ICPerm perm);
80 /* start reading/writing the preferences */
81 /* must be balanaced by a ICEnd */
82 /* do not call WaitNextEvent between this pair */
83 /* specify either icReadOnlyPerm or icReadWritePerm */
84 /* note that this may open resource files and leave them open until ICEnd */
85
86 pascal ICError ICGetPref(ICInstance inst, ConstStr255Param key, ICAttr *attr, Ptr buf, long *size);
87 /* this routine may be called without a ICBegin/ICEnd pair, in which case */
88 /* it implicitly calls ICBegin(inst, icReadOnlyPerm */
89 /* given a key string, returns the attributes and the (optionally) the data for a preference */
90 /* key must not be the empty string */
91 /* if buf is nil then no data fetched and incoming size is ignored*/
92 /* size must be non-negative, is size of allocated space for data at buf */
93 /* attr and size and always set on return */
94 /* size is actual size of data (if key present); */
95 /* attr is pref attributes */
96 /* if icTruncatedErr then everything is valid, except you lost some data, size is size of real data*/
97 /* on other errors, attr is ICattr_no_change and size is 0 */
98
99 pascal ICError ICSetPref(ICInstance inst, ConstStr255Param key, ICAttr attr, Ptr buf, long size);
100 /* this routine may be called without a ICBegin/ICEnd pair, in which case */
101 /* it implicitly calls ICBegin(inst, icReadWritePerm */
102 /* given a key string, sets the attributes and the data for a preference (either is optional); */
103 /* key must not be the empty string */
104 /* if buf is nil then no data stored and size is ignored, used for setting attr */
105 /* size must be non-negative, is size of the data at buf to store */
106 /* icPermErr if ICBegin was given icReadOnlyPerm */
107 /* icPermErr if current attr is locked, new attr is locked and buf <> nil */
108
109 pascal ICError ICCountPref(ICInstance inst, long *count);
110 /* count total number of preferences */
111 /* if error then count is 0 */
112
113 pascal ICError ICGetIndPref(ICInstance inst, long n, Str255 key);
114 /* return the key of the Nth preference */
115 /* n must be positive */
116 /* icPrefNotFoundErr if n is beyond the last preference */
117
118 pascal ICError ICDeletePref(ICInstance inst, ConstStr255Param key);
119 /* delete the preference specified by key */
120 /* key must not be the empty string */
121 /* preference specified by key must be present */
122 /* icPrefNotFoundErr if it isn't */
123
124 pascal ICError ICEnd(ICInstance inst);
125 /* stop reading/writing the preferences */
126
127 pascal ICError ICDefaultFileName(ICInstance inst, Str63 name);
128 /* return the default file name */
129 /* the component calls this routine to set up the default internet configuration file name*/
130 /* this allows this operation to be intercepted by a component that has captured us */
131 /* it currently gets it from the component resource file */
132 /* the glue version is hardwired */
133
134 pascal ICError ICGetComponentInstance(ICInstance inst, Ptr *component_inst);
135 /* returns noErr and the component instance that we're talking to, if we're using the component */
136 /* returns an error and nil if we're doing it with glue */
137
138 #ifdef __cplusplus
139 }
140 #endif __cplusplus
141
142 #endif

  ViewVC Help
Powered by ViewVC 1.1.22