File: testing.h

package info (click to toggle)
glyr 1.0.6+git20140423-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,724 kB
  • ctags: 1,275
  • sloc: ansic: 13,062; python: 1,052; ruby: 75; makefile: 15
file content (75 lines) | stat: -rw-r--r-- 2,503 bytes parent folder | download | duplicates (2)
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
/***********************************************************
 * This file is part of glyr
 * + a command-line tool and library to download various sort of musicrelated metadata.
 * + Copyright (C) [2011]  [Christopher Pahl]
 * + Hosted at: https://github.com/sahib/glyr
 *
 * glyr 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 3 of the License, or
 * (at your option) any later version.
 *
 * glyr 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 glyr. If not, see <http://www.gnu.org/licenses/>.
 **************************************************************/

#ifndef GLYR_TESTING_H
#define GLYR_TESTING_H

/**
 * SECTION:testing
 * @short_description: Testing interface to libglyr
 * @title: Testing
 * @section_id:
 * @stability: Stable
 * @include: glyr/testing.h
 *
 * A bunch for function that are not meant for general use.
 * They are merely for developers that want to have automated
 * tests for their providers.
 */
#ifdef __cplusplus
extern "C"
{
#endif

#include "types.h"

    /**
     * glyr_testing_call_url:
     * @provider_name: Which provider to ask
     * @type: What type the provider belongs to
     * @query: What exactly to search for
     *
     * Call a provider's url-builder function and deliver it's result
     * This is meant for testing purpose only.
     *
     * Returns: The URL that the provider would want to download
     **/
    const char * glyr_testing_call_url (const char * provider_name, GLYR_GET_TYPE type, GlyrQuery * query);

    /**
     * glyr_testing_call_parser:
     * @provider_name: Which provider to ask
     * @type: What type the provider belongs to
     * @query: What exactly to search for
     * @cache: Parseable Input to the parser (e.g. a HTML-page)
     *
     * Call a certain parser. Example: ("google",GLYR_GET_COVERART,&query,pagesource_cache);
     * This is meant for testing purpose only.
     *
     * Returns: A list of more or less finished items.
     **/
    GlyrMemCache * glyr_testing_call_parser (const char * provider_name, GLYR_GET_TYPE type, GlyrQuery * query, GlyrMemCache * cache);


#ifdef __cplusplus
}
#endif

#endif