uri-util: Added complete syntax comment.

dovecot · May 16, 2016 · 62ed330 · 62ed330
1 parent a643e1e
commit 62ed330
Showing 1 changed file with 70 additions and 31 deletions.
diff --git a/src/lib/uri-util.c b/src/lib/uri-util.c
@@ -8,37 +8,76 @@
 
 #include <ctype.h>
 
-/*
- * Generic URI parsing.
- *
- * [URI-GEN] RFC3986 Appendix A:
- *
- * host             = IP-literal / IPv4address / reg-name
- * port             = *DIGIT
- * reg-name         = *( unreserved / pct-encoded / sub-delims )
- * unreserved       = ALPHA / DIGIT / "-" / "." / "_" / "~"
- * pct-encoded      = "%" HEXDIG HEXDIG
- * sub-delims       = "!" / "$" / "&" / "'" / "(" / ")"
- *                  / "*" / "+" / "," / ";" / "="
- * IP-literal       = "[" ( IPv6address / IPvFuture  ) "]"
- * IPvFuture        = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" )
- * IPv6address      =                            6( h16 ":" ) ls32
- *                  /                       "::" 5( h16 ":" ) ls32
- *                  / [               h16 ] "::" 4( h16 ":" ) ls32
- *                  / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32
- *                  / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32
- *                  / [ *3( h16 ":" ) h16 ] "::"    h16 ":"   ls32
- *                  / [ *4( h16 ":" ) h16 ] "::"              ls32
- *                  / [ *5( h16 ":" ) h16 ] "::"              h16
- *                  / [ *6( h16 ":" ) h16 ] "::"
- * h16              = 1*4HEXDIG
- * ls32             = ( h16 ":" h16 ) / IPv4address
- * IPv4address      = dec-octet "." dec-octet "." dec-octet "." dec-octet
- * dec-octet        = DIGIT                 ; 0-9
- *                  / %x31-39 DIGIT         ; 10-99
- *                  / "1" 2DIGIT            ; 100-199
- *                  / "2" %x30-34 DIGIT     ; 200-249
- *                  / "25" %x30-35          ; 250-255
+/* [URI-GEN] RFC3986 Appendix A:
+
+   URI           = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
+   absolute-URI  = scheme ":" hier-part [ "?" query ]
+   scheme        = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
+
+   URI-reference = URI / relative-ref
+   relative-ref  = relative-part [ "?" query ] [ "#" fragment ]
+
+   relative-part = "//" authority path-abempty
+                 / path-absolute
+                 / path-noscheme
+                 / path-empty
+   hier-part     = "//" authority path-abempty
+                 / path-absolute
+                 / path-rootless
+                 / path-empty
+
+   authority     = [ userinfo "@" ] host [ ":" port ]
+   userinfo      = *( unreserved / pct-encoded / sub-delims / ":" )
+   host          = IP-literal / IPv4address / reg-name
+   port          = *DIGIT
+
+   IP-literal    = "[" ( IPv6address / IPvFuture  ) "]"
+   IPvFuture     = "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" )
+   IPv6address   =                            6( h16 ":" ) ls32
+                 /                       "::" 5( h16 ":" ) ls32
+                 / [               h16 ] "::" 4( h16 ":" ) ls32
+                 / [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32
+                 / [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32
+                 / [ *3( h16 ":" ) h16 ] "::"    h16 ":"   ls32
+                 / [ *4( h16 ":" ) h16 ] "::"              ls32
+                 / [ *5( h16 ":" ) h16 ] "::"              h16
+                 / [ *6( h16 ":" ) h16 ] "::"
+   h16           = 1*4HEXDIG
+   ls32          = ( h16 ":" h16 ) / IPv4address
+   IPv4address   = dec-octet "." dec-octet "." dec-octet "." dec-octet
+   dec-octet     = DIGIT                 ; 0-9
+                 / %x31-39 DIGIT         ; 10-99
+                 / "1" 2DIGIT            ; 100-199
+                 / "2" %x30-34 DIGIT     ; 200-249
+                 / "25" %x30-35          ; 250-255
+   reg-name      = *( unreserved / pct-encoded / sub-delims )
+
+   path          = path-abempty    ; begins with "/" or is empty
+                 / path-absolute   ; begins with "/" but not "//"
+                 / path-noscheme   ; begins with a non-colon segment
+                 / path-rootless   ; begins with a segment
+                 / path-empty      ; zero characters
+   path-abempty  = *( "/" segment )
+   path-absolute = "/" [ segment-nz *( "/" segment ) ]
+   path-noscheme = segment-nz-nc *( "/" segment )
+   path-rootless = segment-nz *( "/" segment )
+   path-empty    = 0<pchar>
+
+   segment       = *pchar
+   segment-nz    = 1*pchar
+   segment-nz-nc = 1*( unreserved / pct-encoded / sub-delims / "@" )
+                 ; non-zero-length segment without any colon ":"
+   pchar         = unreserved / pct-encoded / sub-delims / ":" / "@"
+
+   query         = *( pchar / "/" / "?" )
+   fragment      = *( pchar / "/" / "?" )
+
+   pct-encoded   = "%" HEXDIG HEXDIG
+   unreserved    = ALPHA / DIGIT / "-" / "." / "_" / "~"
+   reserved      = gen-delims / sub-delims
+   gen-delims    = ":" / "/" / "?" / "#" / "[" / "]" / "@"
+   sub-delims    = "!" / "$" / "&" / "'" / "(" / ")"
+                 / "*" / "+" / "," / ";" / "="
  */
 
 #define URI_MAX_SCHEME_NAME_LEN 64