Add option '--list-canvases' to list exported canvases.
[synfig.git] / synfig-core / trunk / src / tool / main.cpp
index 66efb3c..238d23a 100644 (file)
@@ -6,7 +6,7 @@
 **
 **     \legal
 **     Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
-**     Copyright (c) 2007 Chris Moore
+**     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
@@ -58,8 +58,13 @@ 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
 {
@@ -253,6 +258,7 @@ struct Job
 
        int quality;
        bool sifout;
+       bool list_canvases;
 };
 
 typedef list<String> arg_list_t;
@@ -300,12 +306,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)"));
@@ -319,16 +327,17 @@ 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("--start-time","<time>",_("Set the starting time"));
                Argument("--end-time","<time>",_("Set the ending time"));
-               Argument("--dpi","<res>",_("Set the dots-per-inch"));
+               Argument("--dpi","<res>",_("Set the physical resolution (dots-per-inch)"));
+               Argument("--dpi-x","<res>",_("Set the physical X resolution (dots-per-inch"));
+               Argument("--dpi-y","<res>",_("Set the physical Y resolution (dots-per-inch)"));
+               Argument("--list-canvases",NULL,_("List the exported canvases in the composition"));
                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"));
@@ -344,9 +353,7 @@ 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;
 }
 
@@ -371,11 +378,9 @@ int process_global_flags(arg_list_t &arg_list)
                        return SYNFIGTOOL_HELP;
                }
 
-
                if(*iter == "--help")
                {
                        display_help(1);
-
                        return SYNFIGTOOL_HELP;
                }
 
@@ -404,7 +409,8 @@ int process_global_flags(arg_list_t &arg_list)
                        synfig::Main synfig_main(dirname(progname),&p);
                        synfig::Layer::Book::iterator iter=synfig::Layer::book().begin();
                        for(;iter!=synfig::Layer::book().end();iter++)
-                               cout<<iter->first<<endl;
+                               if (iter->second.category != CATEGORY_DO_NOT_USE)
+                                       cout<<iter->first<<endl;
 
                        return SYNFIGTOOL_HELP;
                }
@@ -414,6 +420,10 @@ int process_global_flags(arg_list_t &arg_list)
                        Progress p(PACKAGE);
                        synfig::Main synfig_main(dirname(progname),&p);
                        iter=next++;
+                       if (iter==arg_list.end()) {
+                               error("The `%s' flag requires a value.  Use --help for a list of options.", "--layer-info");
+                               return SYNFIGTOOL_MISSINGARGUMENT;
+                       }
                        Layer::Handle layer=synfig::Layer::create(*iter);
                        cout<<"Layer Name: "<<layer->get_name()<<endl;
                        cout<<"Localized Layer Name: "<<layer->get_local_name()<<endl;
@@ -451,7 +461,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;
                }
 
@@ -462,7 +471,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;
                }
 
@@ -473,16 +481,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;
                }
 
@@ -498,33 +503,26 @@ int process_global_flags(arg_list_t &arg_list)
 **\n\
 **     " << 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;
                }
        }
@@ -532,6 +530,14 @@ int process_global_flags(arg_list_t &arg_list)
        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-time"      || flag=="--fps"                || flag=="--layer-info" || flag=="--start-time" || flag=="--time"       );
+}
+
 int extract_arg_cluster(arg_list_t &arg_list,arg_list_t &cluster)
 {
        arg_list_t::iterator iter, next;
@@ -544,29 +550,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);
@@ -692,6 +676,8 @@ int extract_RendDesc(arg_list_t &arg_list,RendDesc &desc)
                        //desc.set_gamma(Gamma(atof(iter->c_str())));
                        arg_list.erase(iter);
                }
+               else if (flag_requires_value(*iter))
+                       iter=next++;
        }
        if(w&&h)
        {
@@ -729,6 +715,8 @@ 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;
@@ -747,6 +735,8 @@ 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;
@@ -766,6 +756,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;
@@ -785,6 +777,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;
@@ -806,6 +800,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;
@@ -825,11 +821,27 @@ 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;
 }
 
+int extract_list_canvases(arg_list_t &arg_list,bool &list_canvases)
+{
+       arg_list_t::iterator iter, next;
+
+       for(next=arg_list.begin(),iter=next++;iter!=arg_list.end();iter=next++)
+               if(*iter=="--list-canvases")
+               {
+                       list_canvases = true;
+                       arg_list.erase(iter);
+               }
+
+       return SYNFIGTOOL_OK;
+}
+
 /* === M E T H O D S ======================================================= */
 
 /* === E N T R Y P O I N T ================================================= */
@@ -841,8 +853,11 @@ int main(int argc, char *argv[])
        job_list_t job_list;
 
        setlocale(LC_ALL, "");
+
+#ifdef ENABLE_NLS
        bindtextdomain("synfig", LOCALEDIR);
        textdomain("synfig");
+#endif
 
        progname=argv[0];
        Progress p(argv[0]);
@@ -889,9 +904,8 @@ int main(int argc, char *argv[])
                          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;
@@ -900,6 +914,10 @@ int main(int argc, char *argv[])
                                continue;
                        }
 
+                       bool list_canvases = false;
+                       extract_list_canvases(imageargs, list_canvases);
+                       job_list.front().list_canvases = list_canvases;
+
                        job_list.front().root->set_time(0);
 
                        string canvasid;
@@ -957,7 +975,7 @@ 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;
 
@@ -969,9 +987,25 @@ int main(int argc, char *argv[])
                                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;
+                               {
+                                       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
@@ -1041,8 +1075,6 @@ int main(int argc, char *argv[])
                                job_list.pop_front();
                                continue;
                        }
-                       //string bleh;
-                       //getline(cin,bleh);
                }
        }
 
@@ -1080,7 +1112,22 @@ int main(int argc, char *argv[])
 
                RenderProgress p;
                p.task(job_list.front().filename+" ==> "+job_list.front().outfilename);
-               if(!job_list.front().sifout)
+               if(job_list.front().sifout)
+               {
+                       if(!save_canvas(job_list.front().outfilename,job_list.front().canvas))
+                       {
+                               cerr<<"Render Failure."<<endl;
+                               return SYNFIGTOOL_RENDERFAILURE;
+                       }
+               }
+               else if (job_list.front().list_canvases)
+               {
+                       cerr << "Listing Canvases:" << endl;
+                       Canvas::Children children(job_list.front().canvas->children());
+                       for (Canvas::Children::iterator iter = children.begin(); iter != children.end(); iter++)
+                               cout << "  " << job_list.front().filename << "#:" << (*iter)->get_id() << endl;
+               }
+               else
                {
                        VERBOSE_OUT(1)<<_("Rendering...")<<endl;
                        etl::clock timer;
@@ -1096,14 +1143,6 @@ int main(int argc, char *argv[])
                                cout<<job_list.front().filename+": Rendered in "<<timer()<<" seconds."<<endl;
                        }
                }
-               else
-               {
-                       if(!save_canvas(job_list.front().outfilename,job_list.front().canvas))
-                       {
-                               cerr<<"Render Failure."<<endl;
-                               return SYNFIGTOOL_RENDERFAILURE;
-                       }
-               }
        }
 
        job_list.clear();