1 |
senkov |
113 |
/*************************************************************************** |
2 |
|
|
* * |
3 |
|
|
* LinuxSampler - modular, streaming capable sampler * |
4 |
|
|
* * |
5 |
|
|
* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * |
6 |
|
|
* * |
7 |
|
|
* This program is free software; you can redistribute it and/or modify * |
8 |
|
|
* it under the terms of the GNU General Public License as published by * |
9 |
|
|
* the Free Software Foundation; either version 2 of the License, or * |
10 |
|
|
* (at your option) any later version. * |
11 |
|
|
* * |
12 |
|
|
* This program is distributed in the hope that it will be useful, * |
13 |
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
14 |
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * |
15 |
|
|
* GNU General Public License for more details. * |
16 |
|
|
* * |
17 |
|
|
* You should have received a copy of the GNU General Public License * |
18 |
|
|
* along with this program; if not, write to the Free Software * |
19 |
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, * |
20 |
|
|
* MA 02111-1307 USA * |
21 |
|
|
***************************************************************************/ |
22 |
|
|
|
23 |
senkov |
116 |
/********************************************************* |
24 |
|
|
* This class helps to constuct valid resultsets per |
25 |
|
|
* LSCP protocol specification |
26 |
|
|
* |
27 |
|
|
* Valid results include: |
28 |
|
|
* OK - to ack the request |
29 |
|
|
* Single line to ack the requests and give status |
30 |
|
|
* Several lines of information in the following format: |
31 |
|
|
* LABEL0: VALUE0 |
32 |
|
|
* LABEL1: VALUE1 |
33 |
|
|
* VALELx: VALUEx |
34 |
|
|
* . |
35 |
|
|
* |
36 |
|
|
* ******************************************************/ |
37 |
|
|
|
38 |
senkov |
113 |
#include "lscpresultset.h" |
39 |
|
|
|
40 |
senkov |
116 |
//Construct an empty resultset |
41 |
senkov |
120 |
//Default index is -1 meaning the resultset doesn't have an index |
42 |
|
|
LSCPResultSet::LSCPResultSet(int index) { |
43 |
|
|
result_index = index; |
44 |
senkov |
113 |
count = 0; |
45 |
|
|
storage = ""; |
46 |
senkov |
120 |
result_type = result_type_success; |
47 |
senkov |
113 |
} |
48 |
|
|
|
49 |
senkov |
116 |
//Construct a resultset with a single line |
50 |
senkov |
120 |
//Default index is -1 meaning the resultset doesn't have an index |
51 |
|
|
LSCPResultSet::LSCPResultSet(String Value, int index) { |
52 |
|
|
result_index = index; |
53 |
senkov |
113 |
count = 1; |
54 |
|
|
storage = Value + "\r\n"; |
55 |
senkov |
120 |
result_type = result_type_success; |
56 |
senkov |
113 |
} |
57 |
|
|
|
58 |
senkov |
116 |
//Add a label/value pair to the resultset |
59 |
|
|
//Values could be of different types for now supports String, int and float. |
60 |
senkov |
113 |
void LSCPResultSet::Add(String Label, String Value) { |
61 |
|
|
if (count == -1) |
62 |
|
|
throw LinuxSamplerException("Attempting to change already produced resultset"); |
63 |
senkov |
120 |
if (result_type != result_type_success) |
64 |
|
|
throw LinuxSamplerException("Attempting to create illegal resultset"); |
65 |
senkov |
113 |
storage = storage + Label + ": " + Value + "\r\n"; |
66 |
|
|
count++; |
67 |
|
|
} |
68 |
|
|
|
69 |
senkov |
120 |
void LSCPResultSet::Add(int Value) { |
70 |
|
|
Add(ToString(Value)); |
71 |
|
|
} |
72 |
|
|
|
73 |
senkov |
113 |
void LSCPResultSet::Add(String Label, int Value) { |
74 |
senkov |
120 |
Add(Label, ToString(Value)); |
75 |
senkov |
113 |
} |
76 |
|
|
|
77 |
|
|
void LSCPResultSet::Add(String Label, float Value) { |
78 |
senkov |
120 |
std::stringstream ss; //fixme: had issues with template and float?! |
79 |
|
|
ss << Value; |
80 |
|
|
Add(Label, ss.str()); |
81 |
senkov |
113 |
} |
82 |
|
|
|
83 |
senkov |
116 |
//Add a single string to the resultset |
84 |
senkov |
113 |
void LSCPResultSet::Add(String Value) { |
85 |
senkov |
120 |
if (result_type != result_type_success) |
86 |
|
|
throw LinuxSamplerException("Attempting to create illegal resultset"); |
87 |
senkov |
113 |
if (count == -1) |
88 |
|
|
throw LinuxSamplerException("Attempting to change already produced resultset"); |
89 |
|
|
if (count != 0) |
90 |
|
|
throw LinuxSamplerException("Attempting to create illegal resultset"); |
91 |
|
|
storage = Value + "\r\n"; |
92 |
|
|
count = 1; |
93 |
|
|
} |
94 |
|
|
|
95 |
senkov |
120 |
//Generate an error result set from an exception. |
96 |
|
|
//Per LSCP spec, error result is a sinle line in the following format: |
97 |
|
|
//ERR:<CODE>:Message text\r\n |
98 |
|
|
//This method will be used to generate unknown errors only (code 0) |
99 |
|
|
//To generate errors with other codes as well as warnings use other methods (below). |
100 |
|
|
//Because this is an unknown error, this method will also print message to the stderr. |
101 |
|
|
void LSCPResultSet::Error(LinuxSamplerException e) { |
102 |
|
|
e.PrintMessage(); |
103 |
|
|
Error(e.Message()); |
104 |
|
|
} |
105 |
|
|
|
106 |
|
|
//This will construct an error with a string and error code |
107 |
|
|
//code has a default of 0 |
108 |
|
|
//String has a default of "Undefined Error" |
109 |
|
|
void LSCPResultSet::Error (String message, int code) { |
110 |
|
|
//Even though this is must be a single line resultset we won't throw |
111 |
|
|
//anything here because this is already part of exception handling. |
112 |
|
|
//We'll just 'forget' all previous results (if any) from this resultset. |
113 |
|
|
result_type = result_type_error; |
114 |
|
|
storage = "ERR:" + ToString(code) + ":" + message + "\r\n"; |
115 |
|
|
count = 1; |
116 |
|
|
} |
117 |
|
|
|
118 |
|
|
//This will construct a warning with a string and error code |
119 |
|
|
//code has a default of 0 |
120 |
|
|
//String has a default of "Undefined Error" |
121 |
|
|
void LSCPResultSet::Warning (String message, int code) { |
122 |
|
|
//FIXME: DO we want warnings as part of the resultset or |
123 |
|
|
//do we want them to work like errors??? For now, make them work like errors. |
124 |
|
|
result_type = result_type_warning; |
125 |
|
|
if (result_index == -1) |
126 |
|
|
storage = "WRN:" + ToString(code) + ":" + message + "\r\n"; |
127 |
|
|
else |
128 |
|
|
storage = "WRN[" + ToString(result_index) + "]:" + ToString(code) + ":" + message + "\r\n"; |
129 |
|
|
count = 1; |
130 |
|
|
} |
131 |
|
|
|
132 |
senkov |
116 |
//Produce resultset |
133 |
senkov |
113 |
String LSCPResultSet::Produce(void) { |
134 |
senkov |
120 |
//FIXME: I'm assuming that only a sinle like "OK" can have index |
135 |
senkov |
116 |
if (count == 0) //When there is nothing in the resultset we just send "OK" to ack the request |
136 |
senkov |
120 |
if (result_index == -1) |
137 |
|
|
return "OK\r\n"; |
138 |
|
|
else |
139 |
|
|
return "OK[" + ToString(result_index) + "]\r\n"; |
140 |
senkov |
116 |
if (count == 1) //Single line results are just that, single line |
141 |
senkov |
113 |
return storage; |
142 |
senkov |
116 |
//Multiline results MUST end with a line with a single dot |
143 |
senkov |
113 |
return storage + ".\r\n"; |
144 |
|
|
} |