Clean up option processing

* Support --version on non-UNX, too.

* Consistently show the first unknown option and the help blob in the presence
  of any unknown options.

* There is no need to tunnel --help/--version past oosplash in the soffice
  script, as oosplash is prepared to treat them adequately (esp. not pass them
  over any pipe); this only added unnecessary variance to what spellings exactly
  are supported and how mixtures of --help, --version, and unknown options are
  handled.

Change-Id: I617f2e727e2f0eafd34a2de3b85d441c6783ec4f

desktop/scripts/soffice.sh

@@ -158,21 +158,5 @@ if [ -n "$VALGRINDCHECK" -a -z "$VALGRIND" ] ; then
     exec &>valgrind.log
 fi
 
-# do not pass the request for command line help to oosplash
-for arg in $@ ; do
-    case "$arg" in
-        -h | --h | --he | --hel | --help)
-            "$sd_prog/soffice.bin" --help
-            exit 0
-            ;;
-        -V | --v | --ve | --ver | --vers | --versi | --versio | --version)
-            "$sd_prog/soffice.bin" --version
-            exit 0
-            ;;
-        *)
-            ;;
-    esac
-done
-
 # oosplash does the rest: forcing pages in, javaldx etc. are
 exec $VALGRINDCHECK $STRACECHECK "$sd_prog/oosplash" "$@"

desktop/source/app/app.cxx

@@ -634,7 +634,8 @@ void Desktop::Init()
             // 2nd office startup should terminate after sending cmdlineargs through pipe
             SetBootstrapStatus(BS_TERMINATE);
         }
-        else if ( rCmdLineArgs.IsHelp() )
+        else if ( !rCmdLineArgs.GetUnknown().isEmpty()
+                  || rCmdLineArgs.IsHelp() || rCmdLineArgs.IsVersion() )
         {
             // disable IPC thread in an instance that is just showing a help message
             OfficeIPCThread::DisableOfficeIPCThread();
@@ -1388,6 +1389,22 @@ int Desktop::Main()
         new DesktopContext( com::sun::star::uno::getCurrentContext() ) );
 
     CommandLineArgs& rCmdLineArgs = GetCommandLineArgs();
+    OUString aUnknown( rCmdLineArgs.GetUnknown() );
+    if ( !aUnknown.isEmpty() )
+    {
+        displayCmdlineHelp( aUnknown );
+        return EXIT_FAILURE;
+    }
+    if ( rCmdLineArgs.IsHelp() )
+    {
+        displayCmdlineHelp( OUString() );
+        return EXIT_SUCCESS;
+    }
+    if ( rCmdLineArgs.IsVersion() )
+    {
+        displayVersion();
+        return EXIT_SUCCESS;
+    }
 
     // setup configuration error handling
     ConfigurationErrorHandler aConfigErrHandler;
@@ -1431,14 +1448,6 @@ int Desktop::Main()
 
         SetSplashScreenProgress(25);
 
-#ifndef UNX
-        if ( rCmdLineArgs.IsHelp() )
-        {
-            displayCmdlineHelp();
-            return EXIT_SUCCESS;
-        }
-#endif
-
         // check user installation directory for lockfile so we can be sure
         // there is no other instance using our data files from a remote host
         RTL_LOGFILE_CONTEXT_TRACE( aLog, "desktop (lo119109) Desktop::Main -> Lockfile" );
@@ -2696,10 +2705,10 @@ void Desktop::HandleAppEvent( const ApplicationEvent& rAppEvent )
         }
         break;
     case ApplicationEvent::TYPE_HELP:
-#ifndef UNX
-        // in non unix version allow showing of cmdline help window
-        displayCmdlineHelp();
-#endif
+        displayCmdlineHelp(rAppEvent.GetData());
+        break;
+    case ApplicationEvent::TYPE_VERSION:
+        displayVersion();
         break;
     case ApplicationEvent::TYPE_OPEN:
         {

desktop/source/app/cmdlineargs.cxx

@@ -287,26 +287,25 @@ void CommandLineArgs::ParseCommandLine_Impl( Supplier& supplier )
                     {
                         bConversionOutEvent = true;
                     }
-#if defined UNX
                     else
                     // because it's impossible to filter these options that
                     // are handled in the soffice shell script with the
                     // primitive tools that /bin/sh offers, ignore them here
-                    if (!oArg.equalsIgnoreAsciiCaseAsciiL(RTL_CONSTASCII_STRINGPARAM("backtrace")) &&
+                    if (
+#if defined UNX
+                        !oArg.equalsIgnoreAsciiCaseAsciiL(RTL_CONSTASCII_STRINGPARAM("backtrace")) &&
                         !oArg.equalsIgnoreAsciiCaseAsciiL(RTL_CONSTASCII_STRINGPARAM("strace")) &&
                         !oArg.equalsIgnoreAsciiCaseAsciiL(RTL_CONSTASCII_STRINGPARAM("valgrind")) &&
                     // for X Session Management, handled in
                     // vcl/unx/generic/app/sm.cxx:
                         !oArg.match("session=") &&
+#endif
                     //ignore additional legacy options that don't do anything anymore
-                        !oArg.equalsIgnoreAsciiCaseAsciiL(RTL_CONSTASCII_STRINGPARAM("nocrashreport")))
+                        !oArg.equalsIgnoreAsciiCaseAsciiL(RTL_CONSTASCII_STRINGPARAM("nocrashreport")) &&
+                        m_unknown.isEmpty())
                     {
-                        fprintf(stderr, "Unknown option %s\n",
-                            rtl::OUStringToOString(aArg, osl_getThreadTextEncoding()).getStr());
-                        fprintf(stderr, "Run 'soffice --help' to see a full list of available command line options.\n");
-                        m_unknown = true;
+                        m_unknown = aArg;
                     }
-#endif
                 }
                 else
                 {
@@ -624,7 +623,6 @@ void CommandLineArgs::InitParamValues()
     m_helpbase = false;
     m_psn = false;
     m_version = false;
-    m_unknown = false;
     m_splashpipe = false;
     m_bEmpty = true;
     m_bDocumentArgs  = false;
@@ -762,7 +760,7 @@ bool CommandLineArgs::IsVersion() const
     return m_version;
 }
 
-bool CommandLineArgs::HasUnknown() const
+OUString CommandLineArgs::GetUnknown() const
 {
     return m_unknown;
 }

desktop/source/app/cmdlineargs.hxx

@@ -93,9 +93,10 @@ class CommandLineArgs: private boost::noncopyable
         bool                IsWeb() const;
         bool                IsVersion() const;
         bool                HasModuleParam() const;
-        bool                HasUnknown() const;
         bool                WantsToLoadDocument() const;
 
+        OUString            GetUnknown() const;
+
         // Access to string parameters
         bool                    HasSplashPipe() const;
         std::vector< rtl::OUString > const & GetAccept() const;
@@ -153,9 +154,10 @@ class CommandLineArgs: private boost::noncopyable
         bool m_helpbase;
         bool m_psn;
         bool m_version;
-        bool m_unknown;
         bool m_splashpipe;
 
+        OUString m_unknown;
+
         bool m_bEmpty; // No Args at all
         bool m_bDocumentArgs; // A document creation/open/load arg is used
         std::vector< rtl::OUString > m_accept;

desktop/source/app/cmdlinehelp.cxx

@@ -136,7 +136,7 @@ namespace desktop
 
     rtl::OUString ReplaceStringHookProc(const rtl::OUString& rStr);
 
-    void displayCmdlineHelp()
+    void displayCmdlineHelp(OUString const & unknown)
     {
         // if you put variables in other chunks don't forget to call the replace routines
         // for those chunks...
@@ -147,6 +147,11 @@ namespace desktop
         String aHelpMessage_bottom(aCmdLineHelp_bottom, RTL_TEXTENCODING_ASCII_US);
         aHelpMessage_version = ReplaceStringHookProc(aHelpMessage_version);
         aHelpMessage_head.SearchAndReplaceAscii( "%CMDNAME", String( "soffice", RTL_TEXTENCODING_ASCII_US) );
+        if (!unknown.isEmpty())
+        {
+            aHelpMessage_head = "Unknown option: " + unknown + "\n\n"
+                + aHelpMessage_head;
+        }
 #ifdef UNX
         // on unix use console for output
         fprintf(stdout, "%s%s",

desktop/source/app/cmdlinehelp.hxx

@@ -5,7 +5,7 @@
 
 namespace desktop
 {
-    void displayCmdlineHelp( void );
+    void displayCmdlineHelp( OUString const & unknown );
     void displayVersion();
 #ifndef UNX
     class CmdlineHelpDialog : public ModalDialog

desktop/source/app/sofficemain.cxx

@@ -60,22 +60,25 @@ extern "C" int DESKTOP_DLLPUBLIC soffice_main()
     // handle --version and --help already here, otherwise they would be handled
     // after VCL initialization that might fail if $DISPLAY is not set
     const desktop::CommandLineArgs& rCmdLineArgs = aDesktop.GetCommandLineArgs();
+    OUString aUnknown( rCmdLineArgs.GetUnknown() );
+    if ( !aUnknown.isEmpty() )
+    {
+        desktop::Desktop::InitApplicationServiceManager();
+        desktop::displayCmdlineHelp( aUnknown );
+        return EXIT_FAILURE;
+    }
     if ( rCmdLineArgs.IsHelp() )
     {
         desktop::Desktop::InitApplicationServiceManager();
-        desktop::displayCmdlineHelp();
+        desktop::displayCmdlineHelp( OUString() );
         return EXIT_SUCCESS;
     }
-    else if ( rCmdLineArgs.IsVersion() )
+    if ( rCmdLineArgs.IsVersion() )
     {
         desktop::Desktop::InitApplicationServiceManager();
         desktop::displayVersion();
         return EXIT_SUCCESS;
     }
-    else if ( rCmdLineArgs.HasUnknown() )
-    {
-        return EXIT_FAILURE;
-    }
 #endif
     return SVMain();
 #if defined ANDROID

desktop/unx/source/args.c

@@ -48,30 +48,34 @@ static struct {
     unsigned int  bInhibitSplash : 1;
     unsigned int  bInhibitPagein : 1;
     unsigned int  bInhibitJavaLdx : 1;
+    unsigned int  bInhibitPipe : 1;
     const char   *pPageinType;
 } pArgDescr[] = {
     /* have a trailing argument */
-    { "pt",         1, 0, 0, 0, NULL },
-    { "display",    1, 0, 0, 0, NULL },
+    { "pt",         1, 0, 0, 0, 0, NULL },
+    { "display",    1, 0, 0, 0, 0, NULL },
 
     /* no splash */
-    { "nologo",     0, 1, 0, 0, NULL },
-    { "headless",   0, 1, 0, 0, NULL },
-    { "invisible",  0, 1, 0, 0, NULL },
-    { "quickstart", 0, 1, 0, 0, NULL },
-    { "minimized",  0, 1, 0, 0, NULL },
+    { "nologo",     0, 1, 0, 0, 0, NULL },
+    { "headless",   0, 1, 0, 0, 0, NULL },
+    { "invisible",  0, 1, 0, 0, 0, NULL },
+    { "quickstart", 0, 1, 0, 0, 0, NULL },
+    { "minimized",  0, 1, 0, 0, 0, NULL },
 
     /* pagein bits */
-    { "writer",     0, 0, 0, 0, "pagein-writer"  },
-    { "calc",       0, 0, 0, 0, "pagein-calc"    },
-    { "draw",       0, 0, 0, 0, "pagein-draw"    },
-    { "impress",    0, 0, 0, 0, "pagein-impress" },
-
-    /* nothing much */
-    { "version",    0, 1, 1, 1, NULL },
-    { "help",       0, 1, 1, 1, NULL },
-    { "h",          0, 1, 1, 1, NULL },
-    { "?",          0, 1, 1, 1, NULL },
+    { "writer",     0, 0, 0, 0, 0, "pagein-writer"  },
+    { "calc",       0, 0, 0, 0, 0, "pagein-calc"    },
+    { "draw",       0, 0, 0, 0, 0, "pagein-draw"    },
+    { "impress",    0, 0, 0, 0, 0, "pagein-impress" },
+
+    /* Do not send --help/--version over the pipe, as their output shall go to
+       the calling process's stdout (ideally, this would also happen in the
+       presence of unknown options); also prevent splash/pagein/javaldx overhead
+       (as these options will be processed early in soffice_main): */
+    { "version",    0, 1, 1, 1, 1, NULL },
+    { "help",       0, 1, 1, 1, 1, NULL },
+    { "h",          0, 1, 1, 1, 1, NULL },
+    { "?",          0, 1, 1, 1, 1, NULL },
 };
 
 Args *args_parse (void)
@@ -133,6 +137,7 @@ Args *args_parse (void)
                 args->bInhibitSplash  |= pArgDescr[j].bInhibitSplash;
                 args->bInhibitPagein  |= pArgDescr[j].bInhibitPagein;
                 args->bInhibitJavaLdx |= pArgDescr[j].bInhibitJavaLdx;
+                args->bInhibitPipe    |= pArgDescr[j].bInhibitPipe;
                 if (pArgDescr[j].pPageinType)
                     args->pPageinType = pArgDescr[j].pPageinType;
                 break;

desktop/unx/source/args.h

@@ -38,6 +38,7 @@ typedef struct {
   sal_Bool     bInhibitSplash;  // should we show a splash screen
   sal_Bool     bInhibitPagein;  // should we run pagein ?
   sal_Bool     bInhibitJavaLdx; // should we run javaldx ?
+  sal_Bool     bInhibitPipe;    // for --help and --version
 
   sal_uInt32   nArgsEnv;        // number of -env: style args
   sal_uInt32   nArgsTotal;      // number of -env: as well as -writer style args

desktop/unx/source/start.c

@@ -831,21 +831,24 @@ SAL_IMPLEMENT_MAIN_WITH_ARGS( argc, argv )
     if ( pUsePlugin && !strcmp(pUsePlugin, "svp") )
         args->bInhibitSplash = sal_True;
 
-    pPipePath = get_pipe_path( args->pAppPath );
-
-    if ( ( fd = connect_pipe( pPipePath ) ) >= 0 )
+    if ( !args->bInhibitPipe )
     {
-        rtl_uString *pCwdPath = NULL;
-        osl_getProcessWorkingDir( &pCwdPath );
+        pPipePath = get_pipe_path( args->pAppPath );
+
+        if ( ( fd = connect_pipe( pPipePath ) ) >= 0 )
+        {
+            rtl_uString *pCwdPath = NULL;
+            osl_getProcessWorkingDir( &pCwdPath );
 
-        bSentArgs = send_args( fd, pCwdPath );
+            bSentArgs = send_args( fd, pCwdPath );
 
-        close( fd );
-    }
+            close( fd );
+        }
 #if OSL_DEBUG_LEVEL > 1
-    else
-        ustr_debug( "Failed to connect to pipe", pPipePath );
+        else
+            ustr_debug( "Failed to connect to pipe", pPipePath );
 #endif
+    }
 
     if ( !bSentArgs )
     {
@@ -935,7 +938,8 @@ SAL_IMPLEMENT_MAIN_WITH_ARGS( argc, argv )
     }
 
     /* cleanup */
-    rtl_uString_release( pPipePath );
+    if ( pPipePath )
+        rtl_uString_release( pPipePath );
     args_free (args);
 
     return status;

vcl/inc/vcl/svapp.hxx

@@ -113,9 +113,9 @@ class VCL_DLLPUBLIC ApplicationEvent
 {
 public:
     enum Type {
-        TYPE_ACCEPT, TYPE_APPEAR, TYPE_HELP, TYPE_OPEN, TYPE_OPENHELPURL,
-        TYPE_PRINT, TYPE_PRIVATE_DOSHUTDOWN, TYPE_QUICKSTART, TYPE_SHOWDIALOG,
-        TYPE_UNACCEPT
+        TYPE_ACCEPT, TYPE_APPEAR, TYPE_HELP, TYPE_VERSION, TYPE_OPEN,
+        TYPE_OPENHELPURL, TYPE_PRINT, TYPE_PRIVATE_DOSHUTDOWN, TYPE_QUICKSTART,
+        TYPE_SHOWDIALOG, TYPE_UNACCEPT
     };
 
     ApplicationEvent() {}