Home | History | Annotate | Download | only in common
      1 // Copyright (c) 2010 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef CHROME_COMMON_APP_MODE_COMMON_MAC_H_
      6 #define CHROME_COMMON_APP_MODE_COMMON_MAC_H_
      7 #pragma once
      8 
      9 #include <CoreFoundation/CoreFoundation.h>
     10 
     11 // This file contains constants, interfaces, etc. which are common to the
     12 // browser application and the app mode loader (a.k.a. shim).
     13 
     14 namespace app_mode {
     15 
     16 // The ID under which app mode preferences will be recorded
     17 // ("org.chromium.Chromium" or "com.google.Chrome").
     18 extern const CFStringRef kAppPrefsID;
     19 
     20 // The key under which to record the path to the (user-visible) application
     21 // bundle; this key is recorded under the ID given by |kAppPrefsID|.
     22 extern const CFStringRef kLastRunAppBundlePathPrefsKey;
     23 
     24 // Current major/minor version numbers of |ChromeAppModeInfo| (defined below).
     25 const unsigned kCurrentChromeAppModeInfoMajorVersion = 1;
     26 const unsigned kCurrentChromeAppModeInfoMinorVersion = 0;
     27 
     28 // The structure used to pass information from the app mode loader to the
     29 // (browser) framework. This is versioned using major and minor version numbers,
     30 // written below as v<major>.<minor>. Version-number checking is done by the
     31 // framework, and the framework must accept all structures with the same major
     32 // version number. It may refuse to load if the major version of the structure
     33 // is different from the one it accepts.
     34 struct ChromeAppModeInfo {
     35   // Major and minor version number of this structure.
     36   unsigned major_version;  // Required: all versions
     37   unsigned minor_version;  // Required: all versions
     38 
     39   // Original |argc| and |argv|.
     40   int argc;  // Required: v1.0
     41   char** argv;  // Required: v1.0
     42 
     43   // Versioned path to the browser which is being loaded.
     44   char* chrome_versioned_path;  // Required: v1.0
     45 
     46   // Information about the App Mode shortcut:
     47 
     48   // Path to the App Mode Loader application bundle originally run.
     49   char* app_mode_bundle_path;  // Optional: v1.0
     50 
     51   // Short ID string, preferably derived from |app_mode_short_name|. Should be
     52   // safe for the file system.
     53   char* app_mode_id;  // Required: v1.0
     54 
     55   // Short (e.g., one-word) UTF8-encoded name for the shortcut.
     56   char* app_mode_short_name;  // Optional: v1.0
     57 
     58   // Unrestricted (e.g., several-word) UTF8-encoded name for the shortcut.
     59   char* app_mode_name;  // Optional: v1.0
     60 
     61   // URL for the shortcut. Must be a valid URL.
     62   char* app_mode_url;  // Required: v1.0
     63 };
     64 
     65 }  // namespace app_mode
     66 
     67 #endif  // CHROME_COMMON_APP_MODE_COMMON_MAC_H_
     68