Added copyright lines for files I've edited this year.
[synfig.git] / synfig-core / trunk / src / tool / main.cpp
index ed9cac2..b4155f4 100644 (file)
@@ -1,11 +1,12 @@
 /* === S Y N F I G ========================================================= */
-/*!    \file main.cpp
+/*!    \file tool/main.cpp
 **     \brief SYNFIG Tool
 **
-**     $Id: main.cpp,v 1.9 2005/01/23 04:41:10 darco Exp $
+**     $Id$
 **
 **     \legal
 **     Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
+**     Copyright (c) 2007, 2008 Chris Moore
 **
 **     This package is free software; you can redistribute it and/or
 **     modify it under the terms of the GNU General Public License as
@@ -34,6 +35,7 @@
 #include <list>
 #include <ETL/clock>
 #include <algorithm>
+#include <cstring>
 
 #include <synfig/loadcanvas.h>
 #include <synfig/savecanvas.h>
@@ -56,18 +58,26 @@ using namespace synfig;
 
 /* === M A C R O S ========================================================= */
 
+#ifdef ENABLE_NLS
+#undef _
+#define _(x) gettext(x)
+#else
+#undef _
+#define _(x) (x)
+#endif
+
 enum exit_code
 {
-       SYNFIGTOOL_OK                           =0,
-       SYNFIGTOOL_FILENOTFOUND         =1,
-       SYNFIGTOOL_BORRED                       =2,
-       SYNFIGTOOL_HELP                         =3,
-       SYNFIGTOOL_UNKNOWNARGUMENT      =4,     
-       SYNFIGTOOL_UNKNOWNERROR         =5,     
-       SYNFIGTOOL_INVALIDTARGET                =6,     
-       SYNFIGTOOL_RENDERFAILURE                =7,     
-       SYNFIGTOOL_BLANK                                =8,
-       SYNFIGTOOL_BADVERSION           =9,
+       SYNFIGTOOL_OK                           = 0,
+       SYNFIGTOOL_FILENOTFOUND         = 1,
+       SYNFIGTOOL_BORED                        = 2,
+       SYNFIGTOOL_HELP                         = 3,
+       SYNFIGTOOL_UNKNOWNARGUMENT      = 4,
+       SYNFIGTOOL_UNKNOWNERROR         = 5,
+       SYNFIGTOOL_INVALIDTARGET        = 6,
+       SYNFIGTOOL_RENDERFAILURE        = 7,
+       SYNFIGTOOL_BLANK                        8,
+       SYNFIGTOOL_BADVERSION           = 9,
        SYNFIGTOOL_MISSINGARGUMENT      =10
 };
 
@@ -95,11 +105,11 @@ bool print_benchmarks=false;
 class Progress : public synfig::ProgressCallback
 {
        const char *program;
-       
+
 public:
-       
+
        Progress(const char *name):program(name) { }
-       
+
        virtual bool
        task(const String &task)
        {
@@ -122,7 +132,7 @@ public:
        }
 
        virtual bool
-       amount_complete(int current, int total)
+       amount_complete(int /*current*/, int /*total*/)
        {
                return true;
        }
@@ -131,16 +141,16 @@ public:
 class RenderProgress : public synfig::ProgressCallback
 {
        string taskname;
-       
+
        etl::clock clk;
        int clk_scanline; // The scanline at which the clock was reset
        etl::clock clk2;
 
-       float last_time;        
+       float last_time;
 public:
-       
+
        RenderProgress():clk_scanline(0), last_time(0) { }
-       
+
        virtual bool
        task(const String &thetask)
        {
@@ -178,7 +188,7 @@ public:
                        if(clk2()<0.2)
                                return true;
                        clk2.reset();
-                               
+
                        if(scanline)
                                seconds=(int)time+1;
                        else
@@ -187,7 +197,7 @@ public:
                                clk.reset();
                                clk_scanline=scanline;
                        }
-                       
+
                        if(seconds<0)
                        {
                                clk.reset();
@@ -202,7 +212,7 @@ public:
                                days++,hours-=24;
                        while(days>=7)
                                weeks++,days-=7;
-                       
+
                        cerr<<taskname<<": "<<_("Line")<<" "<<scanline<<_(" of ")<<h<<" -- ";
                        //cerr<<time/(h-clk_scanline)<<" ";
                        /*
@@ -213,9 +223,9 @@ public:
                        {
                                //cerr<<"reset"<<endl;
                                clk.reset();
-                               clk_scanline=scanline;                          
+                               clk_scanline=scanline;
                        }
-                       
+
                        if(weeks)
                                cerr<<weeks<<"w ";
                        if(days)
@@ -226,7 +236,7 @@ public:
                                cerr<<minutes<<"m ";
                        if(seconds)
                                cerr<<seconds<<"s ";
-                       
+
                        cerr<<"           \r";
                }
                else
@@ -239,13 +249,13 @@ struct Job
 {
        String filename;
        String outfilename;
-       
+
        RendDesc desc;
 
        Canvas::Handle root;
        Canvas::Handle canvas;
        Target::Handle target;
-       
+
        int quality;
        bool sifout;
 };
@@ -295,12 +305,14 @@ void display_help(int amount)
                                cerr<<strprintf(" %s %s %s",flag, arg, spaces+strlen(arg)+strlen(flag)+1)+description<<endl;
                        else
                                cerr<<strprintf(" %s %s",flag,spaces+strlen(flag))+description<<endl;
-               
                }
        };
-       cerr<<_("syntax: ")<<progname<<" [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])..."<<endl;
-       cerr<<endl;
-       if(amount>=1)
+
+       cerr << endl << _("syntax: ") << progname << " [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])..." << endl << endl;
+
+       if(amount == 0)
+               Argument("--help",NULL,_("Print out usage and syntax info"));
+       else
        {
                Argument("-t","<output type>",_("Specify output target (Default:unknown)"));
                Argument("-w","<pixel width>",_("Set the image width (Use zero for file default)"));
@@ -314,16 +326,13 @@ void display_help(int amount)
                Argument("-c","<canvas id>",_("Render the canvas with the given id instead of the root."));
                Argument("-o","<output file>",_("Specify output filename"));
                Argument("-T","<# of threads>",_("Enable multithreaded renderer using specified # of threads"));
-
                Argument("-b",NULL,_("Print Benchmarks"));
-
                Argument("--fps","<framerate>",_("Set the frame rate"));
                Argument("--time","<time>",_("Render a single frame at <seconds>"));
                Argument("--begin-time","<time>",_("Set the starting time"));
                Argument("--end-time","<time>",_("Set the ending time"));
                Argument("--dpi","<res>",_("Set the dots-per-inch"));
                Argument("--append","<filename>",_("Append layers in <filename> to composition"));
-
                Argument("--layer-info","<layer>",_("Print out layer's description, parameter info, etc."));
                Argument("--layers",NULL,_("Print out the list of available layers"));
                Argument("--targets",NULL,_("Print out the list of available targets"));
@@ -339,16 +348,14 @@ void display_help(int amount)
                Argument("--signal-test",NULL,_("Test signal implementation"));
 #endif
        }
-       else
 
-       Argument("--help",NULL,_("Print out usage and syntax info"));
        cerr<<endl;
 }
 
 int process_global_flags(arg_list_t &arg_list)
 {
        arg_list_t::iterator iter, next;
-       
+
        for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
        {
                if(*iter == "--")
@@ -359,18 +366,16 @@ int process_global_flags(arg_list_t &arg_list)
                        signal_test();
                        return SYNFIGTOOL_HELP;
                }
-               
+
                if(*iter == "--guid-test")
                {
                        guid_test();
                        return SYNFIGTOOL_HELP;
                }
 
-               
                if(*iter == "--help")
                {
                        display_help(1);
-
                        return SYNFIGTOOL_HELP;
                }
 
@@ -446,7 +451,6 @@ int process_global_flags(arg_list_t &arg_list)
                        synfig::Target::Book::iterator iter=synfig::Target::book().begin();
                        for(;iter!=synfig::Target::book().end();iter++)
                                cout<<iter->first<<endl;
-                               
                        return SYNFIGTOOL_HELP;
                }
 
@@ -457,7 +461,6 @@ int process_global_flags(arg_list_t &arg_list)
                        synfig::LinkableValueNode::Book::iterator iter=synfig::LinkableValueNode::book().begin();
                        for(;iter!=synfig::LinkableValueNode::book().end();iter++)
                                cout<<iter->first<<endl;
-                               
                        return SYNFIGTOOL_HELP;
                }
 
@@ -468,16 +471,13 @@ int process_global_flags(arg_list_t &arg_list)
                        synfig::Importer::Book::iterator iter=synfig::Importer::book().begin();
                        for(;iter!=synfig::Importer::book().end();iter++)
                                cout<<iter->first<<endl;
-                               
                        return SYNFIGTOOL_HELP;
                }
 
                if(*iter == "--version")
                {
                        cerr<<PACKAGE<<" "<<VERSION<<endl;
-               
                        arg_list.erase(iter);
-                       
                        return SYNFIGTOOL_HELP;
                }
 
@@ -491,46 +491,48 @@ int process_global_flags(arg_list_t &arg_list)
 **     published by the Free Software Foundation; either version 2 of\n\
 **     the License, or (at your option) any later version.\n\
 **\n\
-**     " << endl << endl;      
+**     " << endl << endl;
                        arg_list.erase(iter);
-                       
                        return SYNFIGTOOL_HELP;
                }
 
                if(*iter == "-v")
                {
                        verbosity++;
-                       
                        arg_list.erase(iter);
-                       
                        continue;
                }
 
                if(*iter == "-q")
                {
                        be_quiet=true;
-
                        arg_list.erase(iter);
-
                        continue;
                }
                if(*iter == "-b")
                {
                        print_benchmarks=true;
-
                        arg_list.erase(iter);
-
                        continue;
                }
        }
-       
+
        return SYNFIGTOOL_OK;
 }
 
+/* true if the given flag takes an extra parameter */
+bool flag_requires_value(String flag) {
+       return (flag=="-a"      || flag=="-c"   || flag=="-g"   || flag=="-h"   || flag=="-o" ||
+                       flag=="-Q"      || flag=="-s"   || flag=="-t"   || flag=="-T"   || flag=="-w" ||
+                       flag=="--append"        || flag=="--begin-time"         || flag=="--dpi"                || flag=="--dpi-x"      ||
+                       flag=="--dpi-y"         || flag=="--end-frame"          || flag=="--end-time"   || flag=="--fps"        ||
+                       flag=="--frame"         || flag=="--start-frame"        || flag=="--start-time" || flag=="--time"       );
+}
+
 int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
 {
        arg_list_t::iterator iter, next;
-       
+
        for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
        {
                if(*iter->begin() != '-')
@@ -539,29 +541,7 @@ int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
                        return SYNFIGTOOL_OK;
                }
 
-               if(
-                       *iter=="-t" ||
-                       *iter=="-w" ||
-                       *iter=="-h" ||
-                       *iter=="-a" ||
-                       *iter=="-g" ||
-                       *iter=="-o" ||
-                       *iter=="-s" ||
-                       *iter=="-Q" ||
-                       *iter=="-c" ||
-                       *iter=="--fps" ||
-                       *iter=="--start-time" ||
-                       *iter=="--begin-time" ||
-                       *iter=="--end-time" ||
-                       *iter=="--start-frame" ||
-                       *iter=="--end-frame" ||
-                       *iter=="--time" ||
-                       *iter=="--frame" ||
-                       *iter=="--dpi" ||
-                       *iter=="--dpi-x" ||
-                       *iter=="--dpi-y" ||
-                       *iter=="--append" ||
-                       *iter=="-T" )
+               if (flag_requires_value(*iter))
                {
                        cluster.push_back(*iter);
                        arg_list.erase(iter);
@@ -571,11 +551,11 @@ int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
                                return SYNFIGTOOL_MISSINGARGUMENT;
                        }
                }
-                       
+
                cluster.push_back(*iter);
                arg_list.erase(iter);
        }
-       
+
        return SYNFIGTOOL_OK;
 }
 
@@ -682,11 +662,13 @@ int extract_RendDesc(arg_list_t &arg_list,RendDesc &desc)
                else if(*iter=="-g")
                {
                        synfig::warning("Gamma argument is currently ignored");
-                       //arg_list.erase(iter);
-                       //iter=next++;
+                       arg_list.erase(iter);
+                       iter=next++;
                        //desc.set_gamma(Gamma(atof(iter->c_str())));
-                       //arg_list.erase(iter);
+                       arg_list.erase(iter);
                }
+               else if (flag_requires_value(*iter))
+                       iter=next++;
        }
        if(w&&h)
        {
@@ -724,8 +706,10 @@ int extract_quality(arg_list_t &arg_list,int &quality)
                        VERBOSE_OUT(1)<<strprintf(_("Quality set to %d"),quality)<<endl;
                        arg_list.erase(iter);
                }
+               else if (flag_requires_value(*iter))
+                       iter=next++;
        }
-       
+
        return SYNFIGTOOL_OK;
 }
 
@@ -742,8 +726,10 @@ int extract_threads(arg_list_t &arg_list,int &threads)
                        VERBOSE_OUT(1)<<strprintf(_("Threads set to %d"),threads)<<endl;
                        arg_list.erase(iter);
                }
+               else if (flag_requires_value(*iter))
+                       iter=next++;
        }
-       
+
        return SYNFIGTOOL_OK;
 }
 
@@ -751,7 +737,7 @@ int extract_target(arg_list_t &arg_list,string &type)
 {
        arg_list_t::iterator iter, next;
        type.clear();
-       
+
        for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
        {
                if(*iter=="-t")
@@ -761,6 +747,8 @@ int extract_target(arg_list_t &arg_list,string &type)
                        type=*iter;
                        arg_list.erase(iter);
                }
+               else if (flag_requires_value(*iter))
+                       iter=next++;
        }
 
        return SYNFIGTOOL_OK;
@@ -770,7 +758,7 @@ int extract_append(arg_list_t &arg_list,string &filename)
 {
        arg_list_t::iterator iter, next;
        filename.clear();
-       
+
        for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
        {
                if(*iter=="--append")
@@ -780,6 +768,8 @@ int extract_append(arg_list_t &arg_list,string &filename)
                        filename=*iter;
                        arg_list.erase(iter);
                }
+               else if (flag_requires_value(*iter))
+                       iter=next++;
        }
 
        return SYNFIGTOOL_OK;
@@ -790,7 +780,7 @@ int extract_outfile(arg_list_t &arg_list,string &outfile)
        arg_list_t::iterator iter, next;
        int ret=SYNFIGTOOL_FILENOTFOUND;
        outfile.clear();
-       
+
        for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
        {
                if(*iter=="-o")
@@ -801,6 +791,8 @@ int extract_outfile(arg_list_t &arg_list,string &outfile)
                        arg_list.erase(iter);
                        ret=SYNFIGTOOL_OK;
                }
+               else if (flag_requires_value(*iter))
+                       iter=next++;
        }
 
        return ret;
@@ -810,7 +802,7 @@ int extract_canvasid(arg_list_t &arg_list,string &canvasid)
 {
        arg_list_t::iterator iter, next;
        //canvasid.clear();
-       
+
        for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
        {
                if(*iter=="-c")
@@ -820,6 +812,8 @@ int extract_canvasid(arg_list_t &arg_list,string &canvasid)
                        canvasid=*iter;
                        arg_list.erase(iter);
                }
+               else if (flag_requires_value(*iter))
+                       iter=next++;
        }
 
        return SYNFIGTOOL_OK;
@@ -834,10 +828,17 @@ int main(int argc, char *argv[])
        int i;
        arg_list_t arg_list;
        job_list_t job_list;
-       
+
+       setlocale(LC_ALL, "");
+
+#ifdef ENABLE_NLS
+       bindtextdomain("synfig", LOCALEDIR);
+       textdomain("synfig");
+#endif
+
        progname=argv[0];
        Progress p(argv[0]);
-       
+
        if(!SYNFIG_CHECK_VERSION())
        {
                cerr<<_("FATAL: Synfig Version Mismatch")<<endl;
@@ -851,38 +852,37 @@ int main(int argc, char *argv[])
 
        for(i=1;i<argc;i++)
                arg_list.push_back(argv[i]);
-       
+
        if((i=process_global_flags(arg_list)))
                return i;
 
        VERBOSE_OUT(1)<<_("verbosity set to ")<<verbosity<<endl;
        synfig::Main synfig_main(dirname(progname),&p);
-       
+
        {
                arg_list_t defaults, imageargs;
                int ret;
-               
+
                // Grab the defaults before the first file
                if ((ret = extract_arg_cluster(arg_list,defaults)) != SYNFIGTOOL_OK)
                  return ret;
-               
+
                while(arg_list.size())
                {
                        string target_name;
                        job_list.push_front(Job());
                        int threads=0;
-                       
+
                        imageargs=defaults;
                        job_list.front().filename=arg_list.front();
                        arg_list.pop_front();
 
                        if ((ret = extract_arg_cluster(arg_list,imageargs)) != SYNFIGTOOL_OK)
                          return ret;
-                       
+
                        // Open the composition
-                       {
-                               job_list.front().root=open_canvas(job_list.front().filename);
-                       }
+                       job_list.front().root=open_canvas(job_list.front().filename);
+
                        if(!job_list.front().root)
                        {
                                cerr<<_("Unable to open ")<<job_list.front().filename<<"."<<endl;
@@ -892,7 +892,7 @@ int main(int argc, char *argv[])
                        }
 
                        job_list.front().root->set_time(0);
-                       
+
                        string canvasid;
                        extract_canvasid(imageargs,canvasid);
                        if(!canvasid.empty())
@@ -907,7 +907,7 @@ int main(int argc, char *argv[])
                                        cerr<<_("Throwing out job...")<<endl;
                                        job_list.pop_front();
                                        continue;
-                                       
+
                                }
                                catch(Exception::BadLinkName)
                                {
@@ -915,12 +915,12 @@ int main(int argc, char *argv[])
                                        cerr<<_("Throwing out job...")<<endl;
                                        job_list.pop_front();
                                        continue;
-                                       
+
                                }
                        }
                        else
                                job_list.front().canvas=job_list.front().root;
-                       
+
                        extract_RendDesc(imageargs,job_list.front().canvas->rend_desc());
                        extract_target(imageargs,target_name);
                        extract_threads(imageargs,threads);
@@ -948,25 +948,37 @@ int main(int argc, char *argv[])
                                        }
                                        VERBOSE_OUT(2)<<_("Appended contents of ")<<composite_file<<endl;
                                }
-                       }while(false);
-                       
+                       } while(false);
+
                        VERBOSE_OUT(4)<<_("Attempting to determine target/outfile...")<<endl;
-                       
+
                        // If the target type is not yet defined,
                        // try to figure it out from the outfile.
                        if(target_name.empty() && !job_list.front().outfilename.empty())
-                       try
                        {
                                VERBOSE_OUT(3)<<_("Target name undefined, attempting to figure it out")<<endl;
-                               string ext=string(find(job_list.front().outfilename.begin(),job_list.front().outfilename.end(),'.')+1,job_list.front().outfilename.end());
+                               string ext = filename_extension(job_list.front().outfilename);
+                               if (ext.length()) ext = ext.substr(1);
                                if(Target::ext_book().count(ext))
+                               {
                                        target_name=Target::ext_book()[ext];
+                                       info("target name not specified - using %s", target_name.c_str());
+                               }
                                else
-                                       target_name=ext;
-                       }
-                       catch(std::length_error)
-                       {
-                               synfig::warning("Length error caught when attempting to figure out target name");
+                               {
+                                       string lower_ext(ext);
+
+                                       for(unsigned int i=0;i<ext.length();i++)
+                                               lower_ext[i] = tolower(ext[i]);
+
+                                       if(Target::ext_book().count(lower_ext))
+                                       {
+                                               target_name=Target::ext_book()[lower_ext];
+                                               info("target name not specified - using %s", target_name.c_str());
+                                       }
+                                       else
+                                               target_name=ext;
+                               }
                        }
 
                        // If the target type is STILL not yet defined, then
@@ -982,9 +994,7 @@ int main(int argc, char *argv[])
                        // given input filename. (ie: change the extension)
                        if(job_list.front().outfilename.empty())
                        {
-                               job_list.front().outfilename=job_list.front().filename;
-                               job_list.front().outfilename.erase(find(job_list.front().outfilename.begin(),job_list.front().outfilename.end(),'.'),job_list.front().outfilename.end());
-                               job_list.front().outfilename+='.';
+                               job_list.front().outfilename = filename_sans_extension(job_list.front().filename) + '.';
                                if(Target::book().count(target_name))
                                        job_list.front().outfilename+=Target::book()[target_name].second;
                                else
@@ -993,10 +1003,10 @@ int main(int argc, char *argv[])
 
                        VERBOSE_OUT(4)<<"target_name="<<target_name<<endl;
                        VERBOSE_OUT(4)<<"outfile_name="<<job_list.front().outfilename<<endl;
-                       
+
                        VERBOSE_OUT(4)<<_("Creating the target...")<<endl;
                        job_list.front().target=synfig::Target::create(target_name,job_list.front().outfilename);
-                       
+
                        if(target_name=="sif")
                        {
                                job_list.front().sifout=true;
@@ -1018,16 +1028,16 @@ int main(int argc, char *argv[])
                        {
                                VERBOSE_OUT(4)<<_("Setting the canvas on the target...")<<endl;
                                job_list.front().target->set_canvas(job_list.front().canvas);
-                               VERBOSE_OUT(4)<<_("Setting the quality of the target...")<<endl;                                
+                               VERBOSE_OUT(4)<<_("Setting the quality of the target...")<<endl;
                                job_list.front().target->set_quality(job_list.front().quality);
                        }
-                       
+
                        // Set the threads for the target
                        if(job_list.front().target && Target_Scanline::Handle::cast_dynamic(job_list.front().target))
                        {
                                Target_Scanline::Handle::cast_dynamic(job_list.front().target)->set_threads(threads);
                        }
-                       
+
                        if(imageargs.size())
                        {
                                cerr<<_("Unidentified arguments for ")<<job_list.front().filename<<": ";
@@ -1038,11 +1048,9 @@ int main(int argc, char *argv[])
                                job_list.pop_front();
                                continue;
                        }
-                       //string bleh;
-                       //getline(cin,bleh);
                }
        }
-       
+
        if(arg_list.size())
        {
                cerr<<_("Unidentified arguments:");
@@ -1051,13 +1059,13 @@ int main(int argc, char *argv[])
                cerr<<endl;
                return SYNFIGTOOL_UNKNOWNARGUMENT;
        }
-       
+
        if(!job_list.size())
        {
                cerr<<_("Nothing to do!")<<endl;
-               return SYNFIGTOOL_BORRED;
+               return SYNFIGTOOL_BORED;
        }
-       
+
        for(;job_list.size();job_list.pop_front())
        {
                VERBOSE_OUT(3)<<job_list.front().filename<<" -- "<<endl<<'\t'<<
@@ -1074,7 +1082,7 @@ int main(int argc, char *argv[])
                        job_list.front().desc.get_br()[0],job_list.front().desc.get_br()[1],
                        job_list.front().desc.get_focus()[0],job_list.front().desc.get_focus()[1]
                        )<<endl;
-               
+
                RenderProgress p;
                p.task(job_list.front().filename+" ==> "+job_list.front().outfilename);
                if(!job_list.front().sifout)
@@ -1102,10 +1110,10 @@ int main(int argc, char *argv[])
                        }
                }
        }
-       
+
        job_list.clear();
-       
+
        VERBOSE_OUT(1)<<_("Done.")<<endl;
-       
+
        return SYNFIGTOOL_OK;
 }