trunk/src/qsamplerUtilities.cpp

// qsamplerUtilities.cpp
//
/****************************************************************************
   Copyright (C) 2004-2007, rncbc aka Rui Nuno Capela. All rights reserved.

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; either version 2
   of the License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License along
   with this program; if not, write to the Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*****************************************************************************/

#include "qsamplerUtilities.h"

#include "qsamplerMainForm.h"

#include <stdio.h>
#include <qregexp.h>

namespace qsamplerUtilities {

static int _hexToNumber(char hex_digit) {
    switch (hex_digit) {
        case '0': return 0;
        case '1': return 1;
        case '2': return 2;
        case '3': return 3;
        case '4': return 4;
        case '5': return 5;
        case '6': return 6;
        case '7': return 7;
        case '8': return 8;
        case '9': return 9;

        case 'a': return 10;
        case 'b': return 11;
        case 'c': return 12;
        case 'd': return 13;
        case 'e': return 14;
        case 'f': return 15;

        case 'A': return 10;
        case 'B': return 11;
        case 'C': return 12;
        case 'D': return 13;
        case 'E': return 14;
        case 'F': return 15;

        default:  return 0;
    }
}

static int _hexsToNumber(char hex_digit0, char hex_digit1) {
    return _hexToNumber(hex_digit1)*16 + _hexToNumber(hex_digit0);
}

// returns true if the connected LSCP server supports escape sequences
static bool _remoteSupportsEscapeSequences() {
    const lscpVersion_t version = getRemoteLscpVersion();
    // LSCP v1.2 or younger required
    return (version.major > 1 || (version.major == 1 && version.minor >= 2));
}

// converts the given file path into a path as expected by LSCP 1.2
QString lscpEscapePath ( const QString& sPath )
{
    if (!_remoteSupportsEscapeSequences()) return sPath;

    QString path(sPath);

    // replace POSIX path escape sequences (%HH) by LSCP escape sequences (\xHH)
    // TODO: missing code for other systems like Windows
    {
        QRegExp regexp("%[0-9a-fA-F][0-9a-fA-F]");
        for (int i = path.find(regexp); i >= 0; i = path.find(regexp, i + 4))
            path.replace(i, 1, "\\x");
    }
    // replace POSIX path escape sequence (%%) by its raw character
    for (int i = path.find("%%"); i >= 0; i = path.find("%%", ++i))
        path.remove(i, 1);

    // replace all non-basic characters by LSCP escape sequences
    {
        const char pathSeparator = '/';
        QRegExp regexp(QRegExp::escape("\\x") + "[0-9a-fA-F][0-9a-fA-F]");
        for (int i = 0; i < int(path.length()); i++) {
            // first skip all previously added LSCP escape sequences
            if (path.find(regexp, i) == i) {
                i += 3;
                continue;
            }
            // now match all non-alphanumerics
            // (we could exclude much more characters here, but that way
            // we're sure it just works^TM)
            const char c = path.at(i).latin1();
            if (
                !(c >= '0' && c <= '9') &&
                !(c >= 'a' && c <= 'z') &&
                !(c >= 'A' && c <= 'Z') &&
                !(c == pathSeparator)
            ) {
                // convert the non-basic character into a LSCP escape sequence
                char buf[5];
                ::snprintf(buf, sizeof(buf), "\\x%02x", static_cast<unsigned char>(c));
                path.replace(i, 1, buf);
                i += 3;
            }
        }
    }

    return path;
}

// converts a path returned by a LSCP command (and may contain escape
// sequences) into the appropriate POSIX path
QString lscpEscapedPathToPosix(QString path) {
    if (!_remoteSupportsEscapeSequences()) return path;

    // first escape all percent ('%') characters for POSIX
    for (int i = path.find('%'); i >= 0; i = path.find('%', i+2))
        path.replace(i, 1, "%%");

    // resolve LSCP hex escape sequences (\xHH)
    QRegExp regexp(QRegExp::escape("\\x") + "[0-9a-fA-F][0-9a-fA-F]");
    for (int i = path.find(regexp); i >= 0; i = path.find(regexp, i + 4)) {
        const QString sHex = path.mid(i+2, 2).lower();
        // the slash has to be escaped for POSIX as well
        if (sHex == "2f") {
            path.replace(i, 4, "%2f");
            continue;
        }
        // all other characters we simply decode
        char cAscii = _hexsToNumber(sHex.at(1).latin1(), sHex.at(0).latin1());
        path.replace(i, 4, cAscii);
    }

    return path;
}

// converts a text returned by a LSCP command and may contain escape
// sequences) into raw text, that is with all escape sequences decoded
QString lscpEscapedTextToRaw(QString txt) {
    if (!_remoteSupportsEscapeSequences()) return txt;

    // resolve LSCP hex escape sequences (\xHH)
    QRegExp regexp(QRegExp::escape("\\x") + "[0-9a-fA-F][0-9a-fA-F]");
    for (int i = txt.find(regexp); i >= 0; i = txt.find(regexp, i + 4)) {
        const QString sHex = txt.mid(i+2, 2).lower();
        // decode into raw ASCII character
        char cAscii = _hexsToNumber(sHex.at(1).latin1(), sHex.at(0).latin1());
        txt.replace(i, 4, cAscii);
    }

    return txt;
}

lscpVersion_t getRemoteLscpVersion (void)
{
    lscpVersion_t result = { 0, 0 };

    qsamplerMainForm *pMainForm = qsamplerMainForm::getInstance();
    if (pMainForm == NULL)
        return result;
    if (pMainForm->client() == NULL)
        return result;

    lscp_server_info_t* pServerInfo =
        ::lscp_get_server_info(pMainForm->client());
    if (pServerInfo && pServerInfo->protocol_version)
        ::sscanf(pServerInfo->protocol_version, "%d.%d",
            &result.major, &result.minor);

    return result;
}

} // namespace qsamplerUtilities
1	schoenebeck	1386	// qsamplerUtilities.cpp
2			//
3			/****************************************************************************
4			Copyright (C) 2004-2007, rncbc aka Rui Nuno Capela. All rights reserved.
5
6			This program is free software; you can redistribute it and/or
7			modify it under the terms of the GNU General Public License
8			as published by the Free Software Foundation; either version 2
9			of the License, or (at your option) any later version.
10
11			This program is distributed in the hope that it will be useful,
12			but WITHOUT ANY WARRANTY; without even the implied warranty of
13			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			GNU General Public License for more details.
15
16			You should have received a copy of the GNU General Public License along
17			with this program; if not, write to the Free Software Foundation, Inc.,
18			51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
20			*****************************************************************************/
21
22			#include "qsamplerUtilities.h"
23
24			#include "qsamplerMainForm.h"
25
26			#include <stdio.h>
27			#include <qregexp.h>
28
29	schoenebeck	1402	namespace qsamplerUtilities {
30
31			static int _hexToNumber(char hex_digit) {
32			switch (hex_digit) {
33			case '0': return 0;
34			case '1': return 1;
35			case '2': return 2;
36			case '3': return 3;
37			case '4': return 4;
38			case '5': return 5;
39			case '6': return 6;
40			case '7': return 7;
41			case '8': return 8;
42			case '9': return 9;
43
44			case 'a': return 10;
45			case 'b': return 11;
46			case 'c': return 12;
47			case 'd': return 13;
48			case 'e': return 14;
49			case 'f': return 15;
50
51			case 'A': return 10;
52			case 'B': return 11;
53			case 'C': return 12;
54			case 'D': return 13;
55			case 'E': return 14;
56			case 'F': return 15;
57
58			default: return 0;
59			}
60			}
61
62			static int _hexsToNumber(char hex_digit0, char hex_digit1) {
63			return _hexToNumber(hex_digit1)*16 + _hexToNumber(hex_digit0);
64			}
65
66			// returns true if the connected LSCP server supports escape sequences
67			static bool _remoteSupportsEscapeSequences() {
68			const lscpVersion_t version = getRemoteLscpVersion();
69			// LSCP v1.2 or younger required
70			return (version.major > 1 \|\| (version.major == 1 && version.minor >= 2));
71			}
72
73	schoenebeck	1386	// converts the given file path into a path as expected by LSCP 1.2
74	capela	1394	QString lscpEscapePath ( const QString& sPath )
75			{
76	schoenebeck	1402	if (!_remoteSupportsEscapeSequences()) return sPath;
77	capela	1394
78	schoenebeck	1402	QString path(sPath);
79	schoenebeck	1386
80			// replace POSIX path escape sequences (%HH) by LSCP escape sequences (\xHH)
81			// TODO: missing code for other systems like Windows
82			{
83			QRegExp regexp("%[0-9a-fA-F][0-9a-fA-F]");
84	schoenebeck	1402	for (int i = path.find(regexp); i >= 0; i = path.find(regexp, i + 4))
85	schoenebeck	1386	path.replace(i, 1, "\\x");
86			}
87	schoenebeck	1402	// replace POSIX path escape sequence (%%) by its raw character
88			for (int i = path.find("%%"); i >= 0; i = path.find("%%", ++i))
89			path.remove(i, 1);
90	capela	1394
91	schoenebeck	1386	// replace all non-basic characters by LSCP escape sequences
92			{
93			const char pathSeparator = '/';
94			QRegExp regexp(QRegExp::escape("\\x") + "[0-9a-fA-F][0-9a-fA-F]");
95			for (int i = 0; i < int(path.length()); i++) {
96			// first skip all previously added LSCP escape sequences
97			if (path.find(regexp, i) == i) {
98			i += 3;
99			continue;
100			}
101			// now match all non-alphanumerics
102			// (we could exclude much more characters here, but that way
103			// we're sure it just works^TM)
104			const char c = path.at(i).latin1();
105			if (
106			!(c >= '0' && c <= '9') &&
107			!(c >= 'a' && c <= 'z') &&
108			!(c >= 'A' && c <= 'Z') &&
109			!(c == pathSeparator)
110			) {
111			// convert the non-basic character into a LSCP escape sequence
112			char buf[5];
113	schoenebeck	1402	::snprintf(buf, sizeof(buf), "\\x%02x", static_cast<unsigned char>(c));
114	schoenebeck	1386	path.replace(i, 1, buf);
115			i += 3;
116			}
117			}
118			}
119	capela	1394
120	schoenebeck	1386	return path;
121			}
122
123	schoenebeck	1402	// converts a path returned by a LSCP command (and may contain escape
124			// sequences) into the appropriate POSIX path
125			QString lscpEscapedPathToPosix(QString path) {
126			if (!_remoteSupportsEscapeSequences()) return path;
127	capela	1394
128	schoenebeck	1402	// first escape all percent ('%') characters for POSIX
129			for (int i = path.find('%'); i >= 0; i = path.find('%', i+2))
130			path.replace(i, 1, "%%");
131
132			// resolve LSCP hex escape sequences (\xHH)
133			QRegExp regexp(QRegExp::escape("\\x") + "[0-9a-fA-F][0-9a-fA-F]");
134			for (int i = path.find(regexp); i >= 0; i = path.find(regexp, i + 4)) {
135			const QString sHex = path.mid(i+2, 2).lower();
136			// the slash has to be escaped for POSIX as well
137			if (sHex == "2f") {
138			path.replace(i, 4, "%2f");
139			continue;
140			}
141			// all other characters we simply decode
142			char cAscii = _hexsToNumber(sHex.at(1).latin1(), sHex.at(0).latin1());
143			path.replace(i, 4, cAscii);
144			}
145
146			return path;
147			}
148
149			// converts a text returned by a LSCP command and may contain escape
150			// sequences) into raw text, that is with all escape sequences decoded
151			QString lscpEscapedTextToRaw(QString txt) {
152			if (!_remoteSupportsEscapeSequences()) return txt;
153
154			// resolve LSCP hex escape sequences (\xHH)
155			QRegExp regexp(QRegExp::escape("\\x") + "[0-9a-fA-F][0-9a-fA-F]");
156			for (int i = txt.find(regexp); i >= 0; i = txt.find(regexp, i + 4)) {
157			const QString sHex = txt.mid(i+2, 2).lower();
158			// decode into raw ASCII character
159			char cAscii = _hexsToNumber(sHex.at(1).latin1(), sHex.at(0).latin1());
160			txt.replace(i, 4, cAscii);
161			}
162
163			return txt;
164			}
165
166	capela	1394	lscpVersion_t getRemoteLscpVersion (void)
167			{
168	schoenebeck	1386	lscpVersion_t result = { 0, 0 };
169
170			qsamplerMainForm *pMainForm = qsamplerMainForm::getInstance();
171	capela	1394	if (pMainForm == NULL)
172	schoenebeck	1402	return result;
173			if (pMainForm->client() == NULL)
174			return result;
175	schoenebeck	1386
176			lscp_server_info_t* pServerInfo =
177			::lscp_get_server_info(pMainForm->client());
178	capela	1394	if (pServerInfo && pServerInfo->protocol_version)
179	schoenebeck	1402	::sscanf(pServerInfo->protocol_version, "%d.%d",
180			&result.major, &result.minor);
181	schoenebeck	1386
182			return result;
183			}
184	schoenebeck	1402
185			} // namespace qsamplerUtilities