From 61b4dc2c645294378fdd93882922a8a05115fc14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Duval?= Date: Fri, 15 Sep 2006 13:56:32 +0000 Subject: [PATCH] improves the checks : now includes initializer, virtuals style fixes HeaderSampler.pl now outputs the good methodsynopsis content to copy/paste git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18853 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- src/documentation/docbook-xsl/html/synop.xsl | 5 +- .../haiku_book/midi/midi2consumer.xml | 2 +- .../haiku_book/midi/midi2endpoint.xml | 6 +- .../haiku_book/midi/midi2localconsumer.xml | 71 +++++++++++-------- .../haiku_book/midi/midi2localproducer.xml | 63 ++++++++-------- .../haiku_book/midi/midi2producer.xml | 6 +- .../docbook/headersampler/HeaderSampler.pl | 21 +++--- 7 files changed, 98 insertions(+), 76 deletions(-) diff --git a/src/documentation/docbook-xsl/html/synop.xsl b/src/documentation/docbook-xsl/html/synop.xsl index 12ac37a455..b16da35309 100644 --- a/src/documentation/docbook-xsl/html/synop.xsl +++ b/src/documentation/docbook-xsl/html/synop.xsl @@ -1074,6 +1074,9 @@ paramdef ::= (#PCDATA|type|replaceable|parameter|funcparams)* + +   + @@ -1086,7 +1089,7 @@ paramdef ::= (#PCDATA|type|replaceable|parameter|funcparams)* - +  =  diff --git a/src/documentation/haiku_book/midi/midi2consumer.xml b/src/documentation/haiku_book/midi/midi2consumer.xml index 6b87b07aaf..282ea1424e 100644 --- a/src/documentation/haiku_book/midi/midi2consumer.xml +++ b/src/documentation/haiku_book/midi/midi2consumer.xml @@ -20,7 +20,7 @@ bigtime_t - Latency + Latency const diff --git a/src/documentation/haiku_book/midi/midi2endpoint.xml b/src/documentation/haiku_book/midi/midi2endpoint.xml index 2c2da1bc06..ce003ddf7d 100644 --- a/src/documentation/haiku_book/midi/midi2endpoint.xml +++ b/src/documentation/haiku_book/midi/midi2endpoint.xml @@ -31,7 +31,7 @@ Name() - const char * + constchar * Name const @@ -56,7 +56,7 @@ SetName - constchar *name + constchar *name @@ -390,7 +390,7 @@ if (endp->IsConsumer()) status_t SetProperties - constBMessage *properties + constBMessage *properties diff --git a/src/documentation/haiku_book/midi/midi2localconsumer.xml b/src/documentation/haiku_book/midi/midi2localconsumer.xml index 2fb618895d..cda4e9ea13 100644 --- a/src/documentation/haiku_book/midi/midi2localconsumer.xml +++ b/src/documentation/haiku_book/midi/midi2localconsumer.xml @@ -46,8 +46,13 @@ - BMidiLocalConsumer(const char *name = NULL) - + BMidiLocalConsumer() + + + BMidiLocalConsumer + constchar *nameNULL + + Creates a new local consumer endpoint. @@ -82,7 +87,8 @@ - void SetLatency(bigtime_t latency) + SetLatency() + SetLatencybigtime_tlatency Changes the published latency of the consumer. @@ -91,7 +97,8 @@ - int32 GetProducerID() + GetProducerID() + int32GetProducerID Returns the ID of the producer that most recently sent a MIDI event to @@ -105,7 +112,8 @@ - void SetTimeout(bigtime_t when, void *data) + SetTimeout() + SetTimeoutbigtime_twhenvoid *data Requests that the Timeout() hook will be called at some point @@ -146,7 +154,8 @@ - virtual void Timeout(void *data) + Timeout() + virtualTimeoutvoid *data Hook function that is called per your own request. @@ -158,8 +167,8 @@ - virtual void Data( - uchar *data, size_t length, bool atomic, bigtime_t time) + Data() + virtualDatauchar *datasize_tlengthboolatomicbigtime_ttime Invoked when raw MIDI is received @@ -205,8 +214,8 @@ - virtual void NoteOff( - uchar channel, uchar note, uchar velocity, bigtime_t time) + NoteOff() + virtualNoteOffucharchannelucharnoteucharvelocitybigtime_ttime Invoked when a Note Off event is received @@ -218,8 +227,8 @@ - virtual void NoteOn( - uchar channel, uchar note, uchar velocity, bigtime_t time) + NoteOn() + virtualNoteOnucharchannelucharnoteucharvelocitybigtime_ttime Invoked when a Note On event is received @@ -231,8 +240,8 @@ - virtual void KeyPressure( - uchar channel, uchar note, uchar pressure, bigtime_t time) + KeyPressure() + virtualKeyPressureucharchannelucharnoteucharpressurebigtime_ttime Invoked when a Polyphonic Pressure (Aftertouch) event is received @@ -244,8 +253,8 @@ - virtual void ControlChange( - uchar channel, uchar controlNumber, uchar controlValue, bigtime_t time) + ControlChange() + virtualControlChangeucharchannelucharcontrolNumberucharcontrolValuebigtime_ttime Invoked when a Controller Change event is received @@ -257,8 +266,8 @@ - virtual void ProgramChange( - uchar channel, uchar programNumber, bigtime_t time) + ProgramChange() + virtualProgramChangeucharchannelucharprogramNumberbigtime_ttime Invoked when a Program Change event is received @@ -270,8 +279,8 @@ - virtual void ChannelPressure( - uchar channel, uchar pressure, bigtime_t time) + ChannelPressure() + virtualChannelPressureucharchannelucharpressurebigtime_ttime Invoked when a Channel Pressure event is received @@ -283,8 +292,8 @@ - virtual void PitchBend( - uchar channel, uchar lsb, uchar msb, bigtime_t time) + PitchBend() + virtualPitchBenducharchannelucharlsbucharmsbbigtime_ttime Invoked when a Pitch Bend event is received @@ -296,8 +305,8 @@ - virtual void SystemExclusive( - void* data, size_t length, bigtime_t time) + SystemExclusive() + virtualSystemExclusivevoid *datasize_tlengthbigtime_ttime Invoked when a System Exclusive event is received @@ -319,8 +328,8 @@ - virtual void SystemCommon( - uchar status, uchar data1, uchar data2, bigtime_t time) + SystemCommon() + virtualSystemCommonucharstatusuchardata1uchardata2bigtime_ttime Invoked when a System Common event is received. @@ -336,8 +345,8 @@ - virtual void SystemRealTime( - uchar status, bigtime_t time) + SystemRealTime() + virtualSystemRealTimeucharstatusbigtime_ttime Invoked when a Real Time event is received @@ -349,7 +358,8 @@ - virtual void TempoChange(int32 beatsPerMinute, bigtime_t time) + TempoChange() + virtualTempoChangeint32beatsPerMinutebigtime_ttime Invoked when a Tempo Change event is received @@ -361,7 +371,8 @@ - virtual void AllNotesOff(bool justChannel, bigtime_t time) + AllNotesOff() + virtualAllNotesOffbooljustChannelbigtime_ttime Not used diff --git a/src/documentation/haiku_book/midi/midi2localproducer.xml b/src/documentation/haiku_book/midi/midi2localproducer.xml index 4cad7b7842..29cd1ad9ec 100644 --- a/src/documentation/haiku_book/midi/midi2localproducer.xml +++ b/src/documentation/haiku_book/midi/midi2localproducer.xml @@ -34,8 +34,11 @@ - BMidiLocalProducer(const char *name = NULL) - + BMidiLocalProducer() + + BMidiLocalProducer + constchar *nameNULL + Creates a new local producer endpoint. @@ -70,8 +73,8 @@ - virtual void Connected(BMidiConsumer *cons) - + Connected() + virtualConnectedconstBMidiConsumer *cons Invoked when a new consumer is connected to this producer @@ -100,7 +103,8 @@ - virtual void Disconnected(BMidiConsumer *cons) + Disconnected() + virtualDisconnectedconstBMidiConsumer *cons Invoked when a consumer is disconnected from this producer. @@ -112,8 +116,8 @@ - void SprayData( - void *data, size_t length, bool atomic = false, bigtime_t time = 0) const + SprayData() + SprayDatavoid *datasize_tlengthboolatomicfalsebigtime_ttime0const Sends raw MIDI data downstream to all connected consumers @@ -149,8 +153,8 @@ - void SprayNoteOff( - uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const + SprayNoteOff() + SprayNoteOffucharchannelucharnoteucharvelocitybigtime_ttime0const Sends a Note Off event to all connected consumers @@ -162,8 +166,8 @@ - void SprayNoteOn( - uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const + SprayNoteOn() + SprayNoteOnucharchannelucharnoteucharvelocitybigtime_ttime0const Sends a Note On event to all connected consumers @@ -175,8 +179,8 @@ - void SprayKeyPressure( - uchar channel, uchar note, uchar pressure, bigtime_t time = 0) const + SprayKeyPressure() + SprayKeyPressureucharchannelucharnoteucharpressurebigtime_ttime0const Sends a Polyphonic Pressure (Aftertouch) event to all connected @@ -189,9 +193,8 @@ - void SprayControlChange( - uchar channel, uchar controlNumber, uchar controlValue, - bigtime_t time = 0) const + SprayControlChange() + SprayControlChangeucharchannelucharcontrolNumberucharcontrolValuebigtime_ttime0const Sends a Controller Change event to all connected consumers. @@ -204,8 +207,8 @@ - void SprayProgramChange( - uchar channel, uchar programNumber, bigtime_t time = 0) const + SprayProgramChange() + SprayProgramChangeucharchannelucharprogramNumberbigtime_ttime0const Sends a Program Change event to all connected consumers @@ -217,8 +220,8 @@ - void SprayChannelPressure( - uchar channel, uchar pressure, bigtime_t time = 0) const + SprayChannelPressure() + SprayChannelPressureucharchannelucharpressurebigtime_ttime0const Sends a Channel Pressure event to all connected consumers @@ -230,8 +233,8 @@ - void SprayPitchBend( - uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const + SprayPitchBend() + SprayPitchBenducharchannelucharlsbucharmsbbigtime_ttime0const Sends a Pitch Bend event to all connected consumers @@ -243,8 +246,8 @@ - void SpraySystemExclusive( - void *data, size_t length, bigtime_t time = 0) const + SpraySystemExclusive() + SpraySystemExclusivevoid *datasize_tlengthbigtime_ttime0const Sends a System Exclusive event to all connected consumers @@ -263,8 +266,8 @@ - void SpraySystemCommon( - uchar status, uchar data1, uchar data2, bigtime_t time = 0) const + SpraySystemCommon() + SpraySystemCommonucharstatusuchardata1uchardata2bigtime_ttime0const Sends a System Common event to the connected consumers @@ -321,8 +324,8 @@ - void SpraySystemRealTime( - uchar status, bigtime_t time = 0) const + SpraySystemRealTime() + SpraySystemRealTimeucharstatusbigtime_ttime0const Sends a Real Time event to the connected consumers @@ -382,8 +385,8 @@ - void SprayTempoChange( - int32 beatsPerMinute, bigtime_t time = 0) const + SprayTempoChange() + SprayTempoChangeint32beatsPerMinutebigtime_ttime0const Sends a Tempo Change event to the connected consumers. diff --git a/src/documentation/haiku_book/midi/midi2producer.xml b/src/documentation/haiku_book/midi/midi2producer.xml index ab2b98cf70..466fd2cf54 100644 --- a/src/documentation/haiku_book/midi/midi2producer.xml +++ b/src/documentation/haiku_book/midi/midi2producer.xml @@ -25,7 +25,7 @@ status_t Connect - constBMidiConsumer * cons + constBMidiConsumer * cons @@ -56,7 +56,7 @@ status_t Disconnect - constBMidiConsumer * cons + constBMidiConsumer * cons @@ -84,7 +84,7 @@ bool IsConnected - constBMidiConsumer * cons + constBMidiConsumer * cons const diff --git a/src/tools/docbook/headersampler/HeaderSampler.pl b/src/tools/docbook/headersampler/HeaderSampler.pl index 8b41d23a27..600f97b68a 100644 --- a/src/tools/docbook/headersampler/HeaderSampler.pl +++ b/src/tools/docbook/headersampler/HeaderSampler.pl @@ -204,16 +204,17 @@ sub PrintFunction { my @args = @_; for (@args) { $paramconst = ""; + $paraminit = ""; if ( /const*/ ) { $paramconst = "const"; } - if ( /[ ]*=[ ]*/ ) { $_ = $`; } # for default value; ex. (short X = 100) + if ( /[ ]*=[ ]*/ ) { $paraminit = "". $' ."" ; $_ = $`; } # for default value; ex. (short X = 100) split(/[ ]+/); $paramname = pop(); $paramtype = pop(); if ( $paramname =~ /^\*/ ) { $paramname = $'; - $paramtype = $paramtype . " *"; + $paramtype .= " *"; } - $_ = "" . $paramconst . $paramtype . " " . $paramname . "" + $_ = $paramconst . "" . $paramtype . " " . $paramname . "" . $paraminit; } $funcargs = join('', @args); @@ -225,16 +226,19 @@ sub PrintFunction { } if ( s/^static[ ]*// ) { if ( $funcmod =~ /^$/ ) { - $funcmode .= " "; + $funcmod .= " "; } - $funcmode .= "static" + $funcmod .= "static" + } + if ($funcmod) { + $funcmod = "" . $funcmod . ""; } if ( /^void/ ) { - $functype = $funcmode . "" + $functype = $funcmod . "" } else { $typeconst = ""; if ( /^const / ) { $typeconst = "const"; $_ = $'; } - $functype = $funcmode . "" . $typeconst . $_ . "" + $functype = $funcmod . $typeconst . "" . $_ . "" } } if ($funcconst) { @@ -291,7 +295,8 @@ sub ValidateDocbook { } } if ( $found == 0 ) { - print $pattern . "\n" ; + $pattern =~ s/\*/ \*/g; + print "".$pattern . "\n" ; } close IN2; }