LSSTApplications  18.1.0
LSSTDataManagementBasePackage
xpa.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  *
4  * This product includes software developed by the
5  * LSST Project (http://www.lsst.org/).
6  * See the COPYRIGHT file
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 #include "pybind11/pybind11.h"
23 
24 #include "xpa.h"
26 
27 namespace py = pybind11;
28 using namespace pybind11::literals;
29 
30 namespace lsst {
31 namespace display {
32 namespace ds9 {
33 
34 namespace {
35 
36 class myXPA {
37 public:
38  static XPA get(bool reset = false) {
39  static myXPA *singleton = NULL;
40 
41  if (reset && singleton != NULL) {
42  delete singleton;
43  singleton = NULL;
44  }
45 
46  if (singleton == NULL) {
47  singleton = new myXPA("w");
48  }
49 
50  return singleton->_xpa;
51  }
52 
53 private:
54  myXPA(myXPA &) = delete;
55  myXPA operator=(myXPA const &) = delete;
56 
57  myXPA(char const *mode) {
58  _xpa = XPAOpen((char *)mode);
59 
60  if (_xpa == NULL) {
61  throw LSST_EXCEPT(lsst::pex::exceptions::IoError, "Unable to open XPA");
62  }
63  }
64 
65  ~myXPA() { XPAClose(_xpa); }
66 
67  static XPA _xpa; // the real XPA connection
68 };
69 
70 XPA myXPA::_xpa = NULL;
71 
72 /*
73  * A binding for XPAGet that talks to only one server, but doesn't have to talk (char **) with SWIG
74  */
75 const char *XPAGet1(XPA xpa, char *xtemplate, char *paramlist, char *mode) {
76  char *buf = NULL; /* desired response */
77  size_t len = 0; /* length of buf; ignored */
78  char *error = NULL; /* returned error if any*/
79 
80  if (xpa == NULL) {
81  xpa = myXPA::get();
82  }
83 
84  int n = XPAGet(xpa, xtemplate, paramlist, mode, &buf, &len, NULL, &error, 1);
85 
86  if (n == 0) {
87  throw LSST_EXCEPT(lsst::pex::exceptions::IoError, "XPAGet returned 0");
88  }
89  if (error != NULL) {
90  return error;
91  }
92  if (buf == NULL) {
93  throw LSST_EXCEPT(lsst::pex::exceptions::IoError, "XPAGet returned a null buffer pointer");
94  }
95 
96  return (buf);
97 }
98 
99 const char *XPASet1(XPA xpa, char *xtemplate, char *paramlist, char *mode,
100  char *buf, // desired extra data
101  int len = -1) // length of buf (or -1 to compute automatically)
102 {
103  if (len < 0) {
104  len = strlen(buf); // length of buf
105  }
106  char *error = NULL; // returned error if any
107 
108  if (xpa == NULL) {
109  xpa = myXPA::get();
110  }
111 
112  int n = XPASet(xpa, xtemplate, paramlist, mode, buf, len, NULL, &error, 1);
113 
114  if (n == 0) {
115  throw LSST_EXCEPT(lsst::pex::exceptions::IoError, "XPASet returned 0");
116  }
117  if (error != NULL) {
118  return error;
119  }
120 
121  return "";
122 }
123 
124 const char *XPASetFd1(XPA xpa, char *xtemplate, char *paramlist, char *mode,
125  int fd) /* file descriptor for xpa to read */
126 {
127  char *error = NULL; /* returned error if any*/
128 
129  if (xpa == NULL) {
130  xpa = myXPA::get();
131  }
132 
133  int n = XPASetFd(xpa, xtemplate, paramlist, mode, fd, NULL, &error, 1);
134 
135  if (n == 0) {
136  throw LSST_EXCEPT(lsst::pex::exceptions::IoError, "XPASetFd returned 0");
137  }
138  if (error != NULL) {
139  return error;
140  }
141  return "";
142 }
143 
144 void reset() { myXPA::get(true); }
145 
146 } // <anonymous>
147 
148 PYBIND11_MODULE(xpa, mod) {
149  py::module::import("lsst.pex.exceptions");
150 
151  py::class_<xparec> cls(mod, "xparec");
152  cls.def(py::init<>());
153 
154  mod.def("get", &XPAGet1, "xpa"_a, "xtemplate"_a, "paramList"_a, "mode"_a);
155  mod.def("reset", &reset);
156  mod.def("set", &XPASet1, "xpa"_a, "xtemplate"_a, "paramList"_a, "mode"_a, "buf"_a, "len"_a = -1);
157  mod.def("setFd1", &XPASetFd1, "xpa"_a, "xtemplate"_a, "paramList"_a, "mode"_a, "fd"_a);
158 }
159 
160 } // ds9
161 } // display
162 } // lsst
PYBIND11_MODULE(xpa, mod)
Definition: xpa.cc:148
Reports errors in external input/output operations.
Definition: Runtime.h:160
A base class for image defects.
T strlen(T... args)
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48