File: autofill_client_ios.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (78 lines) | stat: -rw-r--r-- 3,342 bytes parent folder | download | duplicates (5)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_AUTOFILL_IOS_BROWSER_AUTOFILL_CLIENT_IOS_H_
#define COMPONENTS_AUTOFILL_IOS_BROWSER_AUTOFILL_CLIENT_IOS_H_

#import "base/memory/weak_ptr.h"
#import "components/autofill/core/browser/foundations/autofill_client.h"
#import "components/autofill/ios/browser/autofill_driver_ios_factory.h"
#import "ios/web/public/web_state.h"

namespace autofill {

// Common base class for all AutofillClients on iOS.
//
// There must be at most one instance per web::WebState. Unfortunately, the
// production-code destruction order is complicated and embedder-specific.
//
// Therefore, the contract of AutofillClientIOS is as follows:
// - web_state() must be non-null throughout the lifetime of AutofillClientIOS
//   except perhaps during destruction.
// - AutofillDriverIOSFactory::WebStateDestroyed() must be called at least once
//   and only while the AutofillClientIOS is fully functional (i.e., before any
//   of its or a derived class's members have been destroyed and before
//   web_state() has become null).
class AutofillClientIOS : public AutofillClient {
 public:
  // A function pointer rather than a base::RepeatingCallback to facilitate
  // insertion into a set.
  using FromWebStateImpl = AutofillClientIOS* (*)(web::WebState*);

  // Returns the `AutofillClientIOS` that is associated with `web_state`, if any
  // exists.
  static AutofillClientIOS* FromWebState(web::WebState* web_state);

  // At most one `AutofillClientIOS` may exist per `web_state` at any point in
  // time.
  //
  // Callers must guarantee that after construction of an
  // `AutofillClientIOS(from_web_state_impl, web_state, bridge)`,
  // `from_web_state_impl(web_state)` returns a pointer to this
  // AutofillClientIOS.
  // If and when that is the case, `FromWebState(web_state)` returns the
  // AutofillClientIOS.
  //
  // Typically, `from_web_state_impl` is identical for all instances of a
  // specific subclass of AutofillClientIOS.
  //
  // For example, ChromeAutofillClientIOS is owned by AutofillTabHelper, which
  // is WebStateUserData. Therefore, all ChromeAutofillClientIOS instances pass
  // a pointer to the function calls AutofillTabHelper::FromWebContents() and
  // then returns the AutofillTabHelper's AutofillClientIOS.
  // Similarly for WebViewAutofillClientIOS and other implementations.
  AutofillClientIOS(FromWebStateImpl from_web_state_impl,
                    web::WebState* web_state,
                    id<AutofillDriverIOSBridge> bridge);
  AutofillClientIOS(const AutofillClientIOS&) = delete;
  AutofillClientIOS& operator=(const AutofillClientIOS&) = delete;
  ~AutofillClientIOS() override;

  // Non-null throughout the lifetime of the AutofillClientIOS except perhaps
  // its destructor.
  web::WebState* web_state() const { return web_state_.get(); }

  // Intentionally final to allow it to be called during construction (in
  // particular, transitively by members of subclasses).
  AutofillDriverIOSFactory& GetAutofillDriverFactory() final;

 private:
  base::WeakPtr<web::WebState> web_state_;

  AutofillDriverIOSFactory autofill_driver_factory_;
};

}  // namespace autofill

#endif  // COMPONENTS_AUTOFILL_IOS_BROWSER_AUTOFILL_CLIENT_IOS_H_