aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/lv2plug.in/ns/ext/log/log.ttl
blob: 7d897d6258fc934ca70a7b37a652f4ea33f1acd7 (plain)
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
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
@prefix log:  <http://lv2plug.in/ns/ext/log#> .
@prefix lv2:  <http://lv2plug.in/ns/lv2core#> .
@prefix rdf:  <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd:  <http://www.w3.org/2001/XMLSchema#> .

<http://lv2plug.in/ns/ext/log>
	a lv2:Specification ;
	rdfs:seeAlso <log.h> ,
		<../../meta/meta.ttl> ;
	doap:name "LV2 Log" ;
	doap:shortdesc "A feature for writing log messages." ;
	doap:created "2012-01-12" ;
	doap:developer <http://drobilla.net/drobilla#me> ;
	lv2:documentation """
<p>This extension defines a feature, log:log, which allows plugins to print log
messages with an API much like the standard C printf functions.  This allows,
for example, plugin logs to be nicely presented to the user in a graphical user
interface.</p>

<p>Different log <q>levels</q> (e.g. <q>error</q> or <q>information</q>) are
defined by URI and passed as an LV2_URID.  Thus, the possible number of log
levels is unlimited, but implementations SHOULD use the levels defined in this
extension unless they have a special reason to do otherwise.</p>
""" .

log:Entry
	a rdfs:Class ;
	lv2:documentation """
<p>A log entry.  Subclasses of this class can be passed to LV2_Log_Log methods
to describe the nature of the log message.</p>""" .

log:Error
	a rdfs:Class ;
	rdfs:subClassOf log:Entry ;
	rdfs:comment "An error" .

log:Note
	a rdfs:Class ;
	rdfs:subClassOf log:Entry ;
	rdfs:comment "An informative message" .

log:Warning
	a rdfs:Class ;
	rdfs:subClassOf log:Entry ;
	rdfs:comment "A warning" .

log:Trace
	a rdfs:Class ;
	rdfs:subClassOf log:Entry ;
	lv2:documentation """
<p>A debugging trace.  These entries should not be displayed during normal
operation, but the host may implement an option to display them for debugging
purposes.</p>

<p>This entry type is special in that it may be written to in a real-time
thread.  It is assumed that if debug tracing is enabled, real-time
considerations are not a concern.</p>
""" .

log:log
	a lv2:Feature ;
	lv2:documentation """
<p>A feature which plugins may use to log messages.  To support this feature,
the host must pass an LV2_Feature to LV2_Descriptor::instantiate() with URI
LV2_LOG__log and data pointed to an instance of LV2_Log_Log.</p>
""" .