Settle on the format/write/print family of names

Author: alexcrichton

src/libstd/fmt/mod.rs

@@ -12,33 +12,33 @@
 
 # The Formatting Module
 
-This module contains the runtime support for the `ifmt!` syntax extension. This
+This module contains the runtime support for the `format!` syntax extension. This
 macro is implemented in the compiler to emit calls to this module in order to
 format arguments at runtime into strings and streams.
 
 The functions contained in this module should not normally be used in everyday
-use cases of `ifmt!`. The assumptions made by these functions are unsafe for all
+use cases of `format!`. The assumptions made by these functions are unsafe for all
 inputs, and the compiler performs a large amount of validation on the arguments
-to `ifmt!` in order to ensure safety at runtime. While it is possible to call
+to `format!` in order to ensure safety at runtime. While it is possible to call
 these functions directly, it is not recommended to do so in the general case.
 
 ## Usage
 
-The `ifmt!` macro is intended to be familiar to those coming from C's
-printf/sprintf functions or Python's `str.format` function. In its current
-revision, the `ifmt!` macro returns a `~str` type which is the result of the
+The `format!` macro is intended to be familiar to those coming from C's
+printf/fprintf functions or Python's `str.format` function. In its current
+revision, the `format!` macro returns a `~str` type which is the result of the
 formatting. In the future it will also be able to pass in a stream to format
 arguments directly while performing minimal allocations.
 
-Some examples of the `ifmt!` extension are:
+Some examples of the `format!` extension are:
 
 ~~~{.rust}
-ifmt!("Hello")                  // => ~"Hello"
-ifmt!("Hello, {:s}!", "world")  // => ~"Hello, world!"
-ifmt!("The number is {:d}", 1)  // => ~"The number is 1"
-ifmt!("{}", ~[3, 4])            // => ~"~[3, 4]"
-ifmt!("{value}", value=4)       // => ~"4"
-ifmt!("{} {}", 1, 2)            // => ~"1 2"
+format!("Hello")                  // => ~"Hello"
+format!("Hello, {:s}!", "world")  // => ~"Hello, world!"
+format!("The number is {:d}", 1)  // => ~"The number is 1"
+format!("{}", ~[3, 4])            // => ~"~[3, 4]"
+format!("{value}", value=4)       // => ~"4"
+format!("{} {}", 1, 2)            // => ~"1 2"
 ~~~
 
 From these, you can see that the first argument is a format string. It is
@@ -62,7 +62,7 @@ format string, although it must always be referred to with the same type.
 ### Named parameters
 
 Rust itself does not have a Python-like equivalent of named parameters to a
-function, but the `ifmt!` macro is a syntax extension which allows it to
+function, but the `format!` macro is a syntax extension which allows it to
 leverage named parameters. Named parameters are listed at the end of the
 argument list and have the syntax:
 
@@ -146,7 +146,7 @@ helper methods.
 
 ## Internationalization
 
-The formatting syntax supported by the `ifmt!` extension supports
+The formatting syntax supported by the `format!` extension supports
 internationalization by providing "methods" which execute various different
 outputs depending on the input. The syntax and methods provided are similar to
 other internationalization systems, so again nothing should seem alien.
@@ -164,7 +164,7 @@ to reference the string value of the argument which was selected upon. As an
 example:
 
 ~~~
-ifmt!("{0, select, other{#}}", "hello") // => ~"hello"
+format!("{0, select, other{#}}", "hello") // => ~"hello"
 ~~~
 
 This example is the equivalent of `{0:s}` essentially.
@@ -399,11 +399,11 @@ pub trait Pointer { fn fmt(&Self, &mut Formatter); }
 #[allow(missing_doc)]
 pub trait Float { fn fmt(&Self, &mut Formatter); }
 
-/// The fprintf function takes an output stream, a precompiled format string,
+/// The `write` function takes an output stream, a precompiled format string,
 /// and a list of arguments. The arguments will be formatted according to the
 /// specified format string into the output stream provided.
 ///
-/// See the documentation for `sprintf` for why this function is unsafe and care
+/// See the documentation for `format` for why this function is unsafe and care
 /// should be taken if calling it manually.
 ///
 /// Thankfully the rust compiler provides the macro `fmtf!` which will perform
@@ -419,8 +419,8 @@ pub trait Float { fn fmt(&Self, &mut Formatter); }
 ///
 /// Note that this function assumes that there are enough arguments for the
 /// format string.
-pub unsafe fn fprintf(output: &mut io::Writer,
-                      fmt: &[rt::Piece], args: &[Argument]) {
+pub unsafe fn write(output: &mut io::Writer,
+                    fmt: &[rt::Piece], args: &[Argument]) {
     let mut formatter = Formatter {
         flags: 0,
         width: None,
@@ -436,7 +436,7 @@ pub unsafe fn fprintf(output: &mut io::Writer,
     }
 }
 
-/// The sprintf function takes a precompiled format string and a list of
+/// The format function takes a precompiled format string and a list of
 /// arguments, to return the resulting formatted string.
 ///
 /// This is currently an unsafe function because the types of all arguments
@@ -446,7 +446,7 @@ pub unsafe fn fprintf(output: &mut io::Writer,
 /// for formatting the right type value. Because of this, the function is marked
 /// as `unsafe` if this is being called manually.
 ///
-/// Thankfully the rust compiler provides the macro `ifmt!` which will perform
+/// Thankfully the rust compiler provides the macro `format!` which will perform
 /// all of this validation at compile-time and provides a safe interface for
 /// invoking this function.
 ///
@@ -458,17 +458,17 @@ pub unsafe fn fprintf(output: &mut io::Writer,
 ///
 /// Note that this function assumes that there are enough arguments for the
 /// format string.
-pub unsafe fn sprintf(fmt: &[rt::Piece], args: &[Argument]) -> ~str {
+pub unsafe fn format(fmt: &[rt::Piece], args: &[Argument]) -> ~str {
     let mut output = MemWriter::new();
-    fprintf(&mut output as &mut io::Writer, fmt, args);
+    write(&mut output as &mut io::Writer, fmt, args);
     return str::from_bytes_owned(output.inner());
 }
 
 impl<'self> Formatter<'self> {
 
     // First up is the collection of functions used to execute a format string
     // at runtime. This consumes all of the compile-time statics generated by
-    // the ifmt! syntax extension.
+    // the format! syntax extension.
 
     fn run(&mut self, piece: &rt::Piece, cur: Option<&str>) {
         let setcount = |slot: &mut Option<uint>, cnt: &parse::Count| {
@@ -732,7 +732,7 @@ impl<'self> Formatter<'self> {
 }
 
 /// This is a function which calls are emitted to by the compiler itself to
-/// create the Argument structures that are passed into the `sprintf` function.
+/// create the Argument structures that are passed into the `format` function.
 #[doc(hidden)]
 pub fn argument<'a, T>(f: extern "Rust" fn(&T, &mut Formatter),
                        t: &'a T) -> Argument<'a> {

src/libsyntax/ext/base.rs

@@ -139,10 +139,12 @@ pub fn syntax_expander_table() -> SyntaxEnv {
                                 ext::tt::macro_rules::add_new_extension));
     syntax_expanders.insert(intern(&"fmt"),
                             builtin_normal_tt(ext::fmt::expand_syntax_ext));
-    syntax_expanders.insert(intern(&"ifmt"),
-                            builtin_normal_tt(ext::ifmt::expand_sprintf));
-    syntax_expanders.insert(intern(&"ifmtf"),
-                            builtin_normal_tt(ext::ifmt::expand_fprintf));
+    syntax_expanders.insert(intern(&"format"),
+                            builtin_normal_tt(ext::ifmt::expand_format));
+    syntax_expanders.insert(intern(&"write"),
+                            builtin_normal_tt(ext::ifmt::expand_write));
+    syntax_expanders.insert(intern(&"writeln"),
+                            builtin_normal_tt(ext::ifmt::expand_writeln));
     syntax_expanders.insert(
         intern(&"auto_encode"),
         @SE(ItemDecorator(ext::auto_encode::expand_auto_encode)));

src/libsyntax/ext/expand.rs

@@ -940,6 +940,7 @@ pub fn std_macros() -> @str {
         );
     )
 
+    // NOTE(acrichto): start removing this after the next snapshot
     macro_rules! printf (
         ($arg:expr) => (
             print(fmt!(\"%?\", $arg))
@@ -949,6 +950,7 @@ pub fn std_macros() -> @str {
         )
     )
 
+    // NOTE(acrichto): start removing this after the next snapshot
     macro_rules! printfln (
         ($arg:expr) => (
             println(fmt!(\"%?\", $arg))
@@ -958,6 +960,21 @@ pub fn std_macros() -> @str {
         )
     )
 
+    // FIXME(#6846) once stdio is redesigned, this shouldn't perform an
+    //              allocation but should rather delegate to an invocation of
+    //              write! instead of format!
+    macro_rules! print (
+        () => ();
+        ($arg:expr) => ( ::std::io::print(format!(\"{}\", $arg)));
+        ($fmt:expr, $($arg:tt)+) => ( ::std::io::print(format!($fmt, $($arg)+)))
+    )
+
+    // FIXME(#6846) once stdio is redesigned, this shouldn't perform an
+    //              allocation but should rather delegate to an io::Writer
+    macro_rules! println (
+        ($($arg:tt)*) => ({ print!($($arg)*); ::std::io::println(\"\"); })
+    )
+
     // NOTE: use this after a snapshot lands to abstract the details
     // of the TLS interface.
     macro_rules! local_data_key (

src/libsyntax/ext/ifmt.rs

@@ -697,19 +697,24 @@ impl Context {
     }
 }
 
-pub fn expand_sprintf(ecx: @ExtCtxt, sp: span,
-                      tts: &[ast::token_tree]) -> base::MacResult {
-    expand_ifmt(ecx, sp, tts, false, "sprintf")
+pub fn expand_format(ecx: @ExtCtxt, sp: span,
+                     tts: &[ast::token_tree]) -> base::MacResult {
+    expand_ifmt(ecx, sp, tts, false, false, "format")
 }
 
-pub fn expand_fprintf(ecx: @ExtCtxt, sp: span,
-                      tts: &[ast::token_tree]) -> base::MacResult {
-    expand_ifmt(ecx, sp, tts, true, "fprintf")
+pub fn expand_write(ecx: @ExtCtxt, sp: span,
+                    tts: &[ast::token_tree]) -> base::MacResult {
+    expand_ifmt(ecx, sp, tts, true, false, "write")
 }
 
+pub fn expand_writeln(ecx: @ExtCtxt, sp: span,
+                      tts: &[ast::token_tree]) -> base::MacResult {
+    expand_ifmt(ecx, sp, tts, true, true, "write")
+}
 
 fn expand_ifmt(ecx: @ExtCtxt, sp: span, tts: &[ast::token_tree],
-               leading_arg: bool, function: &str) -> base::MacResult {
+               leading_arg: bool, append_newline: bool,
+               function: &str) -> base::MacResult {
     let mut cx = Context {
         ecx: ecx,
         args: ~[],
@@ -730,6 +735,7 @@ fn expand_ifmt(ecx: @ExtCtxt, sp: span, tts: &[ast::token_tree],
     cx.fmtsp = efmt.span;
     let fmt = expr_to_str(ecx, efmt,
                           "format argument must be a string literal.");
+    let fmt = if append_newline { fmt + "\n" } else { fmt.to_owned() };
 
     let mut err = false;
     do parse::parse_error::cond.trap(|m| {

src/test/compile-fail/ifmt-bad-arg.rs

@@ -9,66 +9,66 @@
 // except according to those terms.
 
 fn main() {
-    // bad arguments to the ifmt! call
+    // bad arguments to the format! call
 
-    ifmt!();                //~ ERROR: expects at least one
-    ifmt!("{}");            //~ ERROR: invalid reference to argument
+    format!();                //~ ERROR: requires at least a format string
+    format!("{}");            //~ ERROR: invalid reference to argument
 
-    ifmt!("{1}", 1);        //~ ERROR: invalid reference to argument `1`
+    format!("{1}", 1);        //~ ERROR: invalid reference to argument `1`
                             //~^ ERROR: argument never used
-    ifmt!("{foo}");         //~ ERROR: no argument named `foo`
+    format!("{foo}");         //~ ERROR: no argument named `foo`
 
-    ifmt!("{}", 1, 2);               //~ ERROR: argument never used
-    ifmt!("{1}", 1, 2);              //~ ERROR: argument never used
-    ifmt!("{}", 1, foo=2);           //~ ERROR: named argument never used
-    ifmt!("{foo}", 1, foo=2);        //~ ERROR: argument never used
-    ifmt!("", foo=2);                //~ ERROR: named argument never used
+    format!("{}", 1, 2);               //~ ERROR: argument never used
+    format!("{1}", 1, 2);              //~ ERROR: argument never used
+    format!("{}", 1, foo=2);           //~ ERROR: named argument never used
+    format!("{foo}", 1, foo=2);        //~ ERROR: argument never used
+    format!("", foo=2);                //~ ERROR: named argument never used
 
-    ifmt!("{0:d} {0:s}", 1);         //~ ERROR: redeclared with type `s`
-    ifmt!("{foo:d} {foo:s}", foo=1); //~ ERROR: redeclared with type `s`
+    format!("{0:d} {0:s}", 1);         //~ ERROR: redeclared with type `s`
+    format!("{foo:d} {foo:s}", foo=1); //~ ERROR: redeclared with type `s`
 
-    ifmt!("{foo}", foo=1, foo=2);    //~ ERROR: duplicate argument
-    ifmt!("#");                      //~ ERROR: `#` reference used
-    ifmt!("", foo=1, 2);             //~ ERROR: positional arguments cannot follow
-    ifmt!("" 1);                     //~ ERROR: expected token: `,`
-    ifmt!("", 1 1);                  //~ ERROR: expected token: `,`
+    format!("{foo}", foo=1, foo=2);    //~ ERROR: duplicate argument
+    format!("#");                      //~ ERROR: `#` reference used
+    format!("", foo=1, 2);             //~ ERROR: positional arguments cannot follow
+    format!("" 1);                     //~ ERROR: expected token: `,`
+    format!("", 1 1);                  //~ ERROR: expected token: `,`
 
-    ifmt!("{0, select, a{} a{} other{}}", "a");    //~ ERROR: duplicate selector
-    ifmt!("{0, plural, =1{} =1{} other{}}", 1u);   //~ ERROR: duplicate selector
-    ifmt!("{0, plural, one{} one{} other{}}", 1u); //~ ERROR: duplicate selector
+    format!("{0, select, a{} a{} other{}}", "a");    //~ ERROR: duplicate selector
+    format!("{0, plural, =1{} =1{} other{}}", 1u);   //~ ERROR: duplicate selector
+    format!("{0, plural, one{} one{} other{}}", 1u); //~ ERROR: duplicate selector
 
     // bad syntax of the format string
 
-    ifmt!("{"); //~ ERROR: unterminated format string
-    ifmt!("\\ "); //~ ERROR: invalid escape
-    ifmt!("\\"); //~ ERROR: expected an escape
+    format!("{"); //~ ERROR: unterminated format string
+    format!("\\ "); //~ ERROR: invalid escape
+    format!("\\"); //~ ERROR: expected an escape
 
-    ifmt!("{0, }", 1); //~ ERROR: expected method
-    ifmt!("{0, foo}", 1); //~ ERROR: unknown method
-    ifmt!("{0, select}", "a"); //~ ERROR: must be followed by
-    ifmt!("{0, plural}", 1); //~ ERROR: must be followed by
+    format!("{0, }", 1); //~ ERROR: expected method
+    format!("{0, foo}", 1); //~ ERROR: unknown method
+    format!("{0, select}", "a"); //~ ERROR: must be followed by
+    format!("{0, plural}", 1); //~ ERROR: must be followed by
 
-    ifmt!("{0, select, a{{}", 1); //~ ERROR: must be terminated
-    ifmt!("{0, select, {} other{}}", "a"); //~ ERROR: empty selector
-    ifmt!("{0, select, other{} other{}}", "a"); //~ ERROR: multiple `other`
-    ifmt!("{0, plural, offset: other{}}", "a"); //~ ERROR: must be an integer
-    ifmt!("{0, plural, offset 1 other{}}", "a"); //~ ERROR: be followed by `:`
-    ifmt!("{0, plural, =a{} other{}}", "a"); //~ ERROR: followed by an integer
-    ifmt!("{0, plural, a{} other{}}", "a"); //~ ERROR: unexpected plural
-    ifmt!("{0, select, a{}}", "a"); //~ ERROR: must provide an `other`
-    ifmt!("{0, plural, =1{}}", "a"); //~ ERROR: must provide an `other`
+    format!("{0, select, a{{}", 1); //~ ERROR: must be terminated
+    format!("{0, select, {} other{}}", "a"); //~ ERROR: empty selector
+    format!("{0, select, other{} other{}}", "a"); //~ ERROR: multiple `other`
+    format!("{0, plural, offset: other{}}", "a"); //~ ERROR: must be an integer
+    format!("{0, plural, offset 1 other{}}", "a"); //~ ERROR: be followed by `:`
+    format!("{0, plural, =a{} other{}}", "a"); //~ ERROR: followed by an integer
+    format!("{0, plural, a{} other{}}", "a"); //~ ERROR: unexpected plural
+    format!("{0, select, a{}}", "a"); //~ ERROR: must provide an `other`
+    format!("{0, plural, =1{}}", "a"); //~ ERROR: must provide an `other`
 
-    ifmt!("{0, plural, other{{0:s}}}", "a"); //~ ERROR: previously used as
-    ifmt!("{:s} {0, plural, other{}}", "a"); //~ ERROR: argument used to
-    ifmt!("{0, select, other{}} \
-           {0, plural, other{}}", "a");
+    format!("{0, plural, other{{0:s}}}", "a"); //~ ERROR: previously used as
+    format!("{:s} {0, plural, other{}}", "a"); //~ ERROR: argument used to
+    format!("{0, select, other{}} \
+             {0, plural, other{}}", "a");
     //~^ ERROR: declared with multiple formats
 
     // It should be illegal to use implicit placement arguments nested inside of
     // format strings because otherwise the "internal pointer of which argument
     // is next" would be invalidated if different cases had different numbers of
     // arguments.
-    ifmt!("{0, select, other{{}}}", "a"); //~ ERROR: cannot use implicit
-    ifmt!("{0, plural, other{{}}}", 1); //~ ERROR: cannot use implicit
-    ifmt!("{0, plural, other{{1:.*d}}}", 1, 2); //~ ERROR: cannot use implicit
+    format!("{0, select, other{{}}}", "a"); //~ ERROR: cannot use implicit
+    format!("{0, plural, other{{}}}", 1); //~ ERROR: cannot use implicit
+    format!("{0, plural, other{{1:.*d}}}", 1, 2); //~ ERROR: cannot use implicit
 }

src/test/compile-fail/ifmt-bad-plural.rs

@@ -9,6 +9,6 @@
 // except according to those terms.
 
 fn main() {
-    ifmt!("{0, plural, other{}}", "a");
+    format!("{0, plural, other{}}", "a");
     //~^ ERROR: expected uint but found
 }

src/test/compile-fail/ifmt-bad-select.rs

@@ -9,6 +9,6 @@
 // except according to those terms.
 
 fn main() {
-    ifmt!("{0, select, other{}}", 2);
+    format!("{0, select, other{}}", 2);
     //~^ ERROR: expected &str but found integral
 }

src/test/compile-fail/ifmt-unimpl.rs

@@ -9,6 +9,6 @@
 // except according to those terms.
 
 fn main() {
-    ifmt!("{:d}", "3");
+    format!("{:d}", "3");
     //~^ ERROR: failed to find an implementation of trait std::fmt::Signed
 }

src/test/compile-fail/ifmt-unknown-trait.rs

@@ -9,6 +9,6 @@
 // except according to those terms.
 
 fn main() {
-    ifmt!("{:notimplemented}", "3");
+    format!("{:notimplemented}", "3");
     //~^ ERROR: unknown format trait `notimplemented`
 }