-
Notifications
You must be signed in to change notification settings - Fork 1
/
dat1FreeLoc.c
120 lines (98 loc) · 3.41 KB
/
dat1FreeLoc.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/*
*+
* Name:
* dat1FreeLoc
* Purpose:
* Free memory associated with an HDS locator
* Language:
* Starlink ANSI C
* Type of Module:
* Library routine
* Invocation:
* HDSLoc * dat1AllocLoc( HDSLoc * locator, int * status );
* Arguments:
* locator = HDSLoc * (Given)
* Locator to free. Do not use this locator after calling this
* routine (consider assigning it to the retun value).
* status = int* (Given and Returned)
* Pointer to global status.
* Returned Value:
* loc = HDSLoc *
* NULL pointer to allow the locator to be assigned the
* return value.
* Description:
* Free the memory associated with the locator.
* Authors:
* TIMJ: Tim Jenness (Cornell)
* {enter_new_authors_here}
* Notes:
* - Locator must have been allocated by dat1AllocLoc()
* - Can be called with a NULL pointer.
* History:
* 2014-08-26 (TIMJ):
* Initial version
* 2020-08-06 (DSB):
* Fill the memory with zeros before freeing it.
* {enter_further_changes_here}
* Copyright:
* Copyright (C) 2014 Cornell University
* All Rights Reserved.
* Licence:
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* - Neither the name of the {organization} nor the names of its
* contributors may be used to endorse or promote products
* derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
* Bugs:
* {note_any_bugs_here}
*-
*/
#include <stdlib.h>
#include "ems.h"
#include "hds1.h"
#include "dat1.h"
#include "dat_err.h"
#include "sae_par.h"
HDSLoc *
dat1FreeLoc( HDSLoc * locator, int * status ) {
/* Do nothing if no locator was supplied */
if (locator) {
/* Sanity check */
if( *status == SAI__OK ){
if( locator->prev || locator->next || locator->hdsFile ){
*status = DAT__FATAL;
emsRep( " ", "Attempt to free HDS locator that is still registered.",
status );
}
}
/* Always attempt to free the memory even if status is bad */
memset( locator, 0, sizeof( *locator ));
MEM_FREE(locator);
}
return NULL;
}