summaryrefslogtreecommitdiffstats
path: root/chrome/test/pyautolib/pyautolib.i
blob: 7136f019779147b55ae7aded56cda6eb6df6e3b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// Swig Interface for PyAuto.
// PyAuto makes the Automation Proxy interface available in Python
//
// Running swig as:
//   swig -python -c++ chrome/test/pyautolib/pyautolib.i
// would generate pyautolib.py, pyautolib_wrap.cxx

// When adding a new class or method, make sure you specify the doc string using
// %feature("docstring", "doc string goes here") NODENAME;
// and attach it to your node (class or method). This doc string will be
// copied over in the generated python classes/methods.

%module(docstring="Python interface to Automtion Proxy.") pyautolib
%feature("autodoc", "1");

%include "std_string.i"
%include "std_wstring.i"

%{
#include "chrome/test/pyautolib/pyautolib.h"
%}

// Make functions using (int argc, char** argv) usable as (sys.argv) from python
%typemap(in) (int argc, char **argv) {
  int i;
  if (!PyList_Check($input)) {
    PyErr_SetString(PyExc_ValueError, "Expecting a list");
    return NULL;
  }
  $1 = PyList_Size($input);
  $2 = (char **) malloc(($1+1)*sizeof(char *));
  for (i = 0; i < $1; i++) {
    PyObject *s = PyList_GetItem($input,i);
    if (!PyString_Check(s)) {
        free($2);
        PyErr_SetString(PyExc_ValueError, "List items must be strings");
        return NULL;
    }
    $2[i] = PyString_AsString(s);
  }
  $2[i] = 0;
}

%typemap(freearg) (int argc, char **argv) {
   if ($2) free($2);
}

%feature("docstring", "Represent a URL. Call spec() to get the string.") GURL;
class GURL {
 public:
  GURL();
  %feature("docstring", "Get the string representation.") spec;
  const std::string& spec() const;
};

%feature("docstring",
         "Represent a file path. Call value() to get the string.") FilePath;
class FilePath {
 public:
  FilePath();
  %feature("docstring", "Get the string representation.") value;
#ifdef SWIGWIN
  const std::wstring& value() const;
#else
  const std::string& value() const;
#endif  // OS_WIN
};

class PyUITestSuite {
 public:
  PyUITestSuite(int argc, char** argv);

  %feature("docstring",
           "Fires up the browser and opens a window.") SetUp;
  virtual void SetUp();
  %feature("docstring",
           "Closes all windows and destroys the browser.") TearDown;
  virtual void TearDown();

  %feature("docstring", "Navigate to the given url in the active tab. "
           "Blocks until page has loaded.") NavigateToURL;
  void NavigateToURL(const char* url_string);

  // BrowserProxy methods
  %feature("docstring", "Set download shelf visibility.") SetShelfVisible;
  void SetShelfVisible(bool is_visible);

  // TabProxy methods
  %feature("docstring",
           "Determine if the download shelf is visible.") IsShelfVisible;
  bool IsShelfVisible();
  %feature("docstring", "Open the Find box.") OpenFindInPage;
  void OpenFindInPage();
  %feature("docstring",
           "Determine if the find box is visible.") IsFindInPageVisible;
  bool IsFindInPageVisible();
  %feature("docstring",
           "Get the path to download directory.") GetDownloadDirectory;
  std::string GetDownloadDirectory();

  // AutomationProxy methods
  %feature("docstring", "Open a new browser window.") OpenNewBrowserWindow;
  bool OpenNewBrowserWindow(bool show);

  // UITestBase methods
  %feature("docstring", "Path to download directory.") user_data_dir;
  FilePath user_data_dir() const;
  %feature("docstring", "Get the index of the active tab.") GetActiveTabIndex;
  int GetActiveTabIndex();
  %feature("docstring", "Get the title of the active tab.") GetActiveTabTitle;
  std::wstring GetActiveTabTitle();
  %feature("docstring", "Get the URL for the active tab. "
           "Returns an instance of GURL") GetActiveTabURL;
  GURL GetActiveTabURL();
  %feature("docstring", "Determine if the browser is running. "
           "Returns False if user closed the window or if the browser died")
      IsBrowserRunning;
  bool IsBrowserRunning();
  %feature("docstring",
           "Count of the number of tabs in the front window.") GetTabCount;
  int GetTabCount();
};