github.com/core-coin/go-core/v2@v2.1.9/mobile/doc.go (about)

     1  // Copyright 2016 by the Authors
     2  // This file is part of the go-core library.
     3  //
     4  // The go-core library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-core library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-core library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  // Package gocore contains the simplified mobile APIs to go-core.
    18  //
    19  // The scope of this package is *not* to allow writing a custom Core client
    20  // with pieces plucked from go-core, rather to allow writing native dapps on
    21  // mobile platforms. Keep this in mind when using or extending this package!
    22  //
    23  // # API limitations
    24  //
    25  // Since gomobile cannot bridge arbitrary types between Go and Android/iOS, the
    26  // exposed APIs need to be manually wrapped into simplified types, with custom
    27  // constructors and getters/setters to ensure that they can be meaningfully used
    28  // from Java/ObjC too.
    29  //
    30  // With this in mind, please try to limit the scope of this package and only add
    31  // essentials without which mobile support cannot work, especially since manually
    32  // syncing the code will be unwieldy otherwise. In the long term we might consider
    33  // writing custom library generators, but those are out of scope now.
    34  //
    35  // Content wise each file in this package corresponds to an entire Go package
    36  // from the go-core repository. Please adhere to this scoping to prevent this
    37  // package getting unmaintainable.
    38  //
    39  // Wrapping guidelines:
    40  //
    41  // Every type that is to be exposed should be wrapped into its own plain struct,
    42  // which internally contains a single field: the original go-core version.
    43  // This is needed because gomobile cannot expose named types for now.
    44  //
    45  // Whenever a method argument or a return type is a custom struct, the pointer
    46  // variant should always be used as value types crossing over between language
    47  // boundaries might have strange behaviors.
    48  //
    49  // Slices of types should be converted into a single multiplicative type wrapping
    50  // a go slice with the methods `Size`, `Get` and `Set`. Further slice operations
    51  // should not be provided to limit the remote code complexity. Arrays should be
    52  // avoided as much as possible since they complicate bounds checking.
    53  //
    54  // If a method has multiple return values (e.g. some return + an error), those
    55  // are generated as output arguments in ObjC. To avoid weird generated names like
    56  // ret_0 for them, please always assign names to output variables if tuples.
    57  //
    58  // Note, a panic *cannot* cross over language boundaries, instead will result in
    59  // an undebuggable SEGFAULT in the process. For error handling only ever use error
    60  // returns, which may be the only or the second return.
    61  package gocore