From 7e550200aa7e74ce7f51ed5e3af9aae87f2210bb Mon Sep 17 00:00:00 2001 From: Mikhail Filimonov Date: Tue, 1 Apr 2025 12:02:45 +0400 Subject: [PATCH 1/4] macos related changes. --- .../Sources/GroupCallContext.swift | 4 +- third-party/td/TdBinding/Package.swift | 28 + .../td/example/swift/src/td-Bridging-Header.h | 9 + .../SharedHeaders/td/memprof/memprof.h | 27 + .../SharedHeaders/td/memprof/memprof_stat.h | 13 + .../SharedHeaders/td/sqlite/sqlite/sqlite3.h | 12100 ++++++++++++++++ .../td/sqlite/sqlite/sqlite3ext.h | 650 + .../td/sqlite/sqlite/sqlite3session.h | 1659 +++ .../td/td/generate/tl-parser/crc32.h | 37 + .../td/generate/tl-parser/portable_endian.h | 88 + .../td/td/generate/tl-parser/tl-parser-tree.h | 178 + .../td/td/generate/tl-parser/tl-parser.h | 223 + .../td/td/generate/tl-parser/tl-tl.h | 55 + .../td/td/generate/tl-parser/wgetopt.h | 193 + .../td/td/generate/tl_json_converter.h | 18 + .../td/td/generate/tl_writer_c.h | 1378 ++ .../td/td/generate/tl_writer_cpp.h | 107 + .../td/td/generate/tl_writer_dotnet.h | 582 + .../td/td/generate/tl_writer_h.h | 95 + .../td/td/generate/tl_writer_hpp.h | 108 + .../td/td/generate/tl_writer_java.h | 124 + .../td/td/generate/tl_writer_jni_cpp.h | 109 + .../td/td/generate/tl_writer_jni_h.h | 57 + .../td/td/generate/tl_writer_td.h | 67 + .../SharedHeaders/td/td/mtproto/AuthData.h | 295 + .../SharedHeaders/td/td/mtproto/AuthKey.h | 134 + .../td/td/mtproto/ConnectionManager.h | 70 + .../td/td/mtproto/CryptoStorer.h | 371 + .../SharedHeaders/td/td/mtproto/DhCallback.h | 29 + .../SharedHeaders/td/td/mtproto/DhHandshake.h | 124 + .../SharedHeaders/td/td/mtproto/Handshake.h | 109 + .../td/td/mtproto/HandshakeActor.h | 56 + .../td/td/mtproto/HandshakeConnection.h | 86 + .../td/td/mtproto/HttpTransport.h | 59 + .../td/td/mtproto/IStreamTransport.h | 40 + .../SharedHeaders/td/td/mtproto/KDF.h | 22 + .../SharedHeaders/td/td/mtproto/MessageId.h | 70 + .../td/td/mtproto/MtprotoQuery.h | 27 + .../td/td/mtproto/NoCryptoStorer.h | 43 + .../SharedHeaders/td/td/mtproto/PacketInfo.h | 33 + .../td/td/mtproto/PacketStorer.h | 44 + .../SharedHeaders/td/td/mtproto/Ping.h | 25 + .../td/td/mtproto/PingConnection.h | 34 + .../SharedHeaders/td/td/mtproto/ProxySecret.h | 69 + .../SharedHeaders/td/td/mtproto/RSA.h | 49 + .../td/td/mtproto/RawConnection.h | 92 + .../td/td/mtproto/SessionConnection.h | 288 + .../td/td/mtproto/TcpTransport.h | 181 + .../SharedHeaders/td/td/mtproto/TlsInit.h | 51 + .../td/td/mtproto/TlsReaderByteFlow.h | 20 + .../SharedHeaders/td/td/mtproto/Transport.h | 139 + .../td/td/mtproto/TransportType.h | 27 + .../SharedHeaders/td/td/mtproto/utils.h | 55 + .../td/td/telegram/AccentColorId.h | 82 + .../td/td/telegram/AccessRights.h | 15 + .../td/td/telegram/AccountManager.h | 136 + .../td/td/telegram/AffectedHistory.h | 33 + .../td/td/telegram/AffiliateType.h | 43 + .../td/td/telegram/AlarmManager.h | 38 + .../td/td/telegram/AnimationsManager.h | 166 + .../td/td/telegram/Application.h | 28 + .../td/td/telegram/AttachMenuManager.h | 140 + .../td/td/telegram/AudiosManager.h | 90 + .../td/td/telegram/AuthManager.h | 233 + .../td/td/telegram/AutoDownloadSettings.h | 39 + .../td/td/telegram/AutosaveManager.h | 117 + .../td/td/telegram/BackgroundId.h | 70 + .../td/td/telegram/BackgroundInfo.h | 61 + .../td/td/telegram/BackgroundManager.h | 243 + .../td/td/telegram/BackgroundType.h | 159 + .../SharedHeaders/td/td/telegram/BaseTheme.h | 22 + .../SharedHeaders/td/td/telegram/Birthdate.h | 69 + .../td/td/telegram/BlockListId.h | 99 + .../td/td/telegram/BoostManager.h | 65 + .../SharedHeaders/td/td/telegram/BotCommand.h | 103 + .../td/td/telegram/BotCommandScope.h | 43 + .../td/td/telegram/BotInfoManager.h | 207 + .../td/td/telegram/BotMenuButton.h | 83 + .../SharedHeaders/td/td/telegram/BotQueries.h | 25 + .../td/td/telegram/BotRecommendationManager.h | 81 + .../td/td/telegram/BotVerification.h | 59 + .../td/td/telegram/BotVerifierSettings.h | 56 + .../td/td/telegram/BusinessAwayMessage.h | 70 + .../td/telegram/BusinessAwayMessageSchedule.h | 54 + .../td/td/telegram/BusinessBotManageBar.h | 86 + .../td/td/telegram/BusinessChatLink.h | 54 + .../td/td/telegram/BusinessConnectedBot.h | 71 + .../td/td/telegram/BusinessConnectionId.h | 79 + .../td/telegram/BusinessConnectionManager.h | 230 + .../td/td/telegram/BusinessGreetingMessage.h | 70 + .../td/td/telegram/BusinessInfo.h | 60 + .../td/td/telegram/BusinessIntro.h | 62 + .../td/td/telegram/BusinessManager.h | 71 + .../td/td/telegram/BusinessRecipients.h | 67 + .../td/td/telegram/BusinessWorkHours.h | 91 + .../SharedHeaders/td/td/telegram/CallActor.h | 249 + .../td/td/telegram/CallDiscardReason.h | 35 + .../SharedHeaders/td/td/telegram/CallId.h | 59 + .../td/td/telegram/CallManager.h | 80 + .../td/td/telegram/CallbackQueriesManager.h | 57 + .../SharedHeaders/td/td/telegram/ChainId.h | 66 + .../SharedHeaders/td/td/telegram/ChannelId.h | 74 + .../td/td/telegram/ChannelParticipantFilter.h | 62 + .../telegram/ChannelRecommendationManager.h | 108 + .../td/td/telegram/ChannelType.h | 15 + .../SharedHeaders/td/td/telegram/ChatId.h | 73 + .../td/td/telegram/ChatManager.h | 929 ++ .../td/td/telegram/ChatReactions.h | 79 + .../SharedHeaders/td/td/telegram/Client.h | 289 + .../td/td/telegram/ClientActor.h | 108 + .../SharedHeaders/td/td/telegram/ClientJson.h | 45 + .../td/td/telegram/CommonDialogManager.h | 59 + .../td/td/telegram/ConfigManager.h | 140 + .../td/td/telegram/ConnectionState.h | 19 + .../td/td/telegram/ConnectionStateManager.h | 39 + .../SharedHeaders/td/td/telegram/Contact.h | 151 + .../td/td/telegram/CountryInfoManager.h | 96 + .../td/td/telegram/CustomEmojiId.h | 74 + .../td/td/telegram/DelayDispatcher.h | 45 + .../td/td/telegram/Dependencies.h | 58 + .../td/td/telegram/DeviceTokenManager.h | 91 + .../SharedHeaders/td/td/telegram/DhCache.h | 26 + .../SharedHeaders/td/td/telegram/DhConfig.h | 38 + .../td/td/telegram/DialogAction.h | 101 + .../td/td/telegram/DialogActionBar.h | 172 + .../td/td/telegram/DialogActionManager.h | 80 + .../td/td/telegram/DialogAdministrator.h | 88 + .../td/td/telegram/DialogBoostLinkInfo.h | 21 + .../SharedHeaders/td/td/telegram/DialogDate.h | 73 + .../SharedHeaders/td/td/telegram/DialogDb.h | 110 + .../td/td/telegram/DialogEventLog.h | 24 + .../td/td/telegram/DialogFilter.h | 172 + .../td/td/telegram/DialogFilterDialogInfo.h | 24 + .../td/td/telegram/DialogFilterId.h | 79 + .../td/td/telegram/DialogFilterInviteLink.h | 50 + .../td/td/telegram/DialogFilterManager.h | 253 + .../SharedHeaders/td/td/telegram/DialogId.h | 98 + .../td/td/telegram/DialogInviteLink.h | 81 + .../td/td/telegram/DialogInviteLinkManager.h | 146 + .../td/td/telegram/DialogListId.h | 140 + .../td/td/telegram/DialogLocation.h | 71 + .../td/td/telegram/DialogManager.h | 395 + .../td/telegram/DialogNotificationSettings.h | 98 + .../td/td/telegram/DialogParticipant.h | 703 + .../td/td/telegram/DialogParticipantFilter.h | 39 + .../td/td/telegram/DialogParticipantManager.h | 322 + .../td/td/telegram/DialogSource.h | 48 + .../SharedHeaders/td/td/telegram/Dimensions.h | 28 + .../SharedHeaders/td/td/telegram/Document.h | 46 + .../td/td/telegram/DocumentsManager.h | 142 + .../td/td/telegram/DownloadManager.h | 113 + .../td/td/telegram/DownloadManagerCallback.h | 70 + .../td/td/telegram/DraftMessage.h | 115 + .../td/td/telegram/EmailVerification.h | 37 + .../SharedHeaders/td/td/telegram/EmojiGroup.h | 79 + .../td/td/telegram/EmojiGroupType.h | 24 + .../td/td/telegram/EmojiStatus.h | 194 + .../td/td/telegram/EncryptedFile.h | 91 + .../SharedHeaders/td/td/telegram/FactCheck.h | 64 + .../td/td/telegram/FileReferenceManager.h | 234 + .../SharedHeaders/td/td/telegram/FolderId.h | 74 + .../SharedHeaders/td/td/telegram/ForumTopic.h | 75 + .../td/td/telegram/ForumTopicEditedData.h | 68 + .../td/td/telegram/ForumTopicIcon.h | 45 + .../td/td/telegram/ForumTopicInfo.h | 95 + .../td/td/telegram/ForumTopicManager.h | 195 + .../SharedHeaders/td/td/telegram/Game.h | 86 + .../td/td/telegram/GameManager.h | 50 + .../td/td/telegram/GitCommitHash.h | 13 + .../td/td/telegram/GiveawayParameters.h | 94 + .../SharedHeaders/td/td/telegram/Global.h | 826 ++ .../td/td/telegram/GlobalPrivacySettings.h | 53 + .../td/td/telegram/GroupCallId.h | 53 + .../td/td/telegram/GroupCallManager.h | 437 + .../td/td/telegram/GroupCallParticipant.h | 112 + .../td/telegram/GroupCallParticipantOrder.h | 64 + .../td/td/telegram/GroupCallVideoPayload.h | 40 + .../td/td/telegram/HashtagHints.h | 48 + .../td/td/telegram/InlineMessageManager.h | 61 + .../td/td/telegram/InlineQueriesManager.h | 192 + .../td/td/telegram/InputBusinessChatLink.h | 36 + .../td/td/telegram/InputDialogId.h | 82 + .../td/td/telegram/InputGroupCallId.h | 72 + .../td/td/telegram/InputInvoice.h | 135 + .../td/td/telegram/InputMessageText.h | 65 + .../SharedHeaders/td/td/telegram/JsonValue.h | 39 + .../td/td/telegram/LabeledPricePart.h | 47 + .../td/td/telegram/LanguagePackManager.h | 201 + .../td/td/telegram/LinkManager.h | 204 + .../SharedHeaders/td/td/telegram/Location.h | 144 + .../SharedHeaders/td/td/telegram/Log.h | 86 + .../SharedHeaders/td/td/telegram/Logging.h | 36 + .../SharedHeaders/td/td/telegram/MediaArea.h | 103 + .../td/td/telegram/MediaAreaCoordinates.h | 59 + .../td/td/telegram/MessageContent.h | 358 + .../td/td/telegram/MessageContentType.h | 129 + .../td/td/telegram/MessageCopyOptions.h | 64 + .../SharedHeaders/td/td/telegram/MessageDb.h | 205 + .../td/td/telegram/MessageEffectId.h | 65 + .../td/td/telegram/MessageEntity.h | 258 + .../td/td/telegram/MessageExtendedMedia.h | 134 + .../td/td/telegram/MessageForwardInfo.h | 175 + .../td/td/telegram/MessageFullId.h | 79 + .../SharedHeaders/td/td/telegram/MessageId.h | 203 + .../td/td/telegram/MessageImportManager.h | 116 + .../td/td/telegram/MessageInputReplyTo.h | 114 + .../td/td/telegram/MessageLinkInfo.h | 33 + .../td/td/telegram/MessageOrigin.h | 101 + .../td/td/telegram/MessageQueryManager.h | 292 + .../td/td/telegram/MessageQuote.h | 85 + .../td/td/telegram/MessageReaction.h | 257 + .../td/td/telegram/MessageReactor.h | 100 + .../td/td/telegram/MessageReplyHeader.h | 37 + .../td/td/telegram/MessageReplyInfo.h | 74 + .../td/td/telegram/MessageSearchFilter.h | 68 + .../td/td/telegram/MessageSearchOffset.h | 30 + .../td/td/telegram/MessageSelfDestructType.h | 74 + .../td/td/telegram/MessageSender.h | 44 + .../td/td/telegram/MessageSource.h | 34 + .../td/td/telegram/MessageThreadDb.h | 98 + .../td/td/telegram/MessageThreadInfo.h | 22 + .../SharedHeaders/td/td/telegram/MessageTtl.h | 58 + .../td/td/telegram/MessageViewer.h | 62 + .../td/td/telegram/MessagesInfo.h | 29 + .../td/td/telegram/MessagesManager.h | 3409 +++++ .../SharedHeaders/td/td/telegram/MinChannel.h | 23 + .../td/td/telegram/MissingInvitee.h | 54 + .../td/td/telegram/NewPasswordState.h | 27 + .../td/td/telegram/Notification.h | 47 + .../telegram/NotificationGroupFromDatabase.h | 24 + .../td/td/telegram/NotificationGroupId.h | 67 + .../td/td/telegram/NotificationGroupInfo.h | 87 + .../td/td/telegram/NotificationGroupKey.h | 43 + .../td/td/telegram/NotificationGroupType.h | 28 + .../td/td/telegram/NotificationId.h | 72 + .../td/td/telegram/NotificationManager.h | 423 + .../td/td/telegram/NotificationObjectFullId.h | 60 + .../td/td/telegram/NotificationObjectId.h | 83 + .../td/telegram/NotificationSettingsManager.h | 259 + .../td/telegram/NotificationSettingsScope.h | 29 + .../td/td/telegram/NotificationSound.h | 69 + .../td/td/telegram/NotificationSoundType.h | 15 + .../td/td/telegram/NotificationType.h | 69 + .../td/td/telegram/OnlineManager.h | 60 + .../td/td/telegram/OptionManager.h | 98 + .../SharedHeaders/td/td/telegram/OrderInfo.h | 82 + .../td/td/telegram/OrderedMessage.h | 228 + .../SharedHeaders/td/td/telegram/Outline.h | 17 + .../td/td/telegram/PaidReactionType.h | 70 + .../td/td/telegram/PasswordManager.h | 212 + .../SharedHeaders/td/td/telegram/Payments.h | 59 + .../SharedHeaders/td/td/telegram/PeerColor.h | 22 + .../td/td/telegram/PeopleNearbyManager.h | 28 + .../td/td/telegram/PhoneNumberManager.h | 64 + .../SharedHeaders/td/td/telegram/Photo.h | 161 + .../td/td/telegram/PhotoFormat.h | 15 + .../SharedHeaders/td/td/telegram/PhotoSize.h | 90 + .../td/td/telegram/PhotoSizeSource.h | 279 + .../td/td/telegram/PhotoSizeType.h | 55 + .../SharedHeaders/td/td/telegram/PollId.h | 55 + .../td/td/telegram/PollManager.h | 270 + .../SharedHeaders/td/td/telegram/Premium.h | 73 + .../td/td/telegram/PremiumGiftOption.h | 61 + .../td/td/telegram/PrivacyManager.h | 75 + .../td/td/telegram/PromoDataManager.h | 52 + .../SharedHeaders/td/td/telegram/PtsManager.h | 58 + .../td/td/telegram/PublicDialogType.h | 22 + .../td/td/telegram/QueryCombiner.h | 51 + .../td/td/telegram/QueryMerger.h | 54 + .../td/td/telegram/QuickReplyManager.h | 484 + .../td/td/telegram/QuickReplyMessageFullId.h | 79 + .../td/td/telegram/QuickReplyShortcutId.h | 94 + .../td/td/telegram/ReactionListType.h | 22 + .../td/td/telegram/ReactionManager.h | 352 + .../telegram/ReactionNotificationSettings.h | 60 + .../td/telegram/ReactionNotificationsFrom.h | 52 + .../td/td/telegram/ReactionType.h | 101 + .../telegram/ReactionUnavailabilityReason.h | 15 + .../td/td/telegram/RecentDialogList.h | 58 + .../td/td/telegram/ReferralProgramInfo.h | 58 + .../td/td/telegram/ReferralProgramManager.h | 103 + .../td/telegram/ReferralProgramParameters.h | 60 + .../td/td/telegram/ReferralProgramSortOrder.h | 21 + .../td/td/telegram/RepliedMessageInfo.h | 121 + .../td/td/telegram/ReplyMarkup.h | 118 + .../td/td/telegram/ReportReason.h | 61 + .../td/td/telegram/RequestActor.h | 160 + .../td/td/telegram/RequestedDialogType.h | 76 + .../SharedHeaders/td/td/telegram/Requests.h | 1755 +++ .../td/td/telegram/RestrictionReason.h | 79 + .../td/td/telegram/SavedMessagesManager.h | 204 + .../td/td/telegram/SavedMessagesTopicId.h | 92 + .../td/td/telegram/ScheduledServerMessageId.h | 65 + .../td/telegram/ScopeNotificationSettings.h | 67 + .../td/td/telegram/SecretChatActor.h | 716 + .../td/td/telegram/SecretChatDb.h | 49 + .../td/td/telegram/SecretChatId.h | 67 + .../td/td/telegram/SecretChatLayer.h | 21 + .../td/td/telegram/SecretChatsManager.h | 88 + .../td/td/telegram/SecretInputMedia.h | 41 + .../td/td/telegram/SecureManager.h | 99 + .../td/td/telegram/SecureStorage.h | 195 + .../td/td/telegram/SecureValue.h | 235 + .../td/td/telegram/SendCodeHelper.h | 118 + .../td/td/telegram/SentEmailCode.h | 50 + .../td/td/telegram/SequenceDispatcher.h | 100 + .../td/td/telegram/ServerMessageId.h | 43 + .../td/td/telegram/SetWithPosition.h | 228 + .../td/td/telegram/SharedDialog.h | 71 + .../td/td/telegram/SpecialStickerSetType.h | 68 + .../td/td/telegram/SponsoredMessageManager.h | 80 + .../SharedHeaders/td/td/telegram/StarAmount.h | 57 + .../SharedHeaders/td/td/telegram/StarGift.h | 106 + .../td/td/telegram/StarGiftAttribute.h | 133 + .../SharedHeaders/td/td/telegram/StarGiftId.h | 71 + .../td/td/telegram/StarGiftManager.h | 109 + .../td/td/telegram/StarManager.h | 117 + .../td/td/telegram/StarSubscription.h | 52 + .../td/td/telegram/StarSubscriptionPricing.h | 55 + .../td/td/telegram/StateManager.h | 102 + .../td/td/telegram/StatisticsManager.h | 98 + .../td/td/telegram/StickerFormat.h | 44 + .../td/td/telegram/StickerListType.h | 22 + .../td/td/telegram/StickerMaskPosition.h | 50 + .../td/td/telegram/StickerPhotoSize.h | 57 + .../td/td/telegram/StickerSetId.h | 63 + .../td/td/telegram/StickerType.h | 29 + .../td/td/telegram/StickersManager.h | 1198 ++ .../td/td/telegram/StorageManager.h | 105 + .../td/td/telegram/StoryContent.h | 73 + .../td/td/telegram/StoryContentType.h | 26 + .../SharedHeaders/td/td/telegram/StoryDb.h | 133 + .../td/td/telegram/StoryForwardInfo.h | 56 + .../td/td/telegram/StoryFullId.h | 77 + .../SharedHeaders/td/td/telegram/StoryId.h | 90 + .../td/td/telegram/StoryInteractionInfo.h | 97 + .../td/td/telegram/StoryListId.h | 95 + .../td/td/telegram/StoryManager.h | 754 + .../td/telegram/StoryNotificationSettings.h | 31 + .../td/td/telegram/StoryStealthMode.h | 55 + .../td/td/telegram/StoryViewer.h | 84 + .../td/td/telegram/SuggestedAction.h | 101 + .../td/td/telegram/SuggestedActionManager.h | 61 + .../SharedHeaders/td/td/telegram/Support.h | 26 + .../td/td/telegram/SynchronousRequests.h | 89 + .../td/td/telegram/TargetDialogTypes.h | 57 + .../SharedHeaders/td/td/telegram/Td.h | 466 + .../SharedHeaders/td/td/telegram/TdCallback.h | 42 + .../SharedHeaders/td/td/telegram/TdDb.h | 199 + .../td/td/telegram/TermsOfService.h | 40 + .../td/td/telegram/TermsOfServiceManager.h | 59 + .../td/td/telegram/ThemeManager.h | 200 + .../td/td/telegram/ThemeSettings.h | 58 + .../td/td/telegram/TimeZoneManager.h | 91 + .../td/td/telegram/TopDialogCategory.h | 38 + .../td/td/telegram/TopDialogManager.h | 131 + .../td/td/telegram/TranscriptionInfo.h | 62 + .../td/td/telegram/TranscriptionManager.h | 135 + .../td/td/telegram/TranslationManager.h | 43 + .../SharedHeaders/td/td/telegram/UniqueId.h | 38 + .../td/td/telegram/UpdatesManager.h | 704 + .../SharedHeaders/td/td/telegram/UserId.h | 94 + .../td/td/telegram/UserManager.h | 1174 ++ .../td/td/telegram/UserPrivacySetting.h | 54 + .../td/td/telegram/UserPrivacySettingRule.h | 157 + .../td/td/telegram/UserStarGift.h | 49 + .../SharedHeaders/td/td/telegram/Usernames.h | 142 + .../SharedHeaders/td/td/telegram/Venue.h | 101 + .../td/td/telegram/VerificationStatus.h | 19 + .../SharedHeaders/td/td/telegram/Version.h | 94 + .../td/td/telegram/VideoNotesManager.h | 94 + .../td/td/telegram/VideosManager.h | 110 + .../td/td/telegram/VoiceNotesManager.h | 84 + .../SharedHeaders/td/td/telegram/WebApp.h | 60 + .../td/td/telegram/WebAppManager.h | 103 + .../td/td/telegram/WebAppOpenParameters.h | 40 + .../td/td/telegram/WebPageBlock.h | 109 + .../SharedHeaders/td/td/telegram/WebPageId.h | 66 + .../td/td/telegram/WebPagesManager.h | 238 + .../td/td/telegram/files/FileBitmask.h | 41 + .../td/td/telegram/files/FileData.h | 60 + .../td/td/telegram/files/FileDb.h | 91 + .../td/td/telegram/files/FileDbId.h | 58 + .../td/telegram/files/FileDownloadManager.h | 128 + .../td/td/telegram/files/FileDownloader.h | 156 + .../td/td/telegram/files/FileEncryptionKey.h | 104 + .../td/td/telegram/files/FileFromBytes.h | 43 + .../td/td/telegram/files/FileGcParameters.h | 37 + .../td/td/telegram/files/FileGcWorker.h | 41 + .../td/telegram/files/FileGenerateManager.h | 74 + .../td/td/telegram/files/FileHashUploader.h | 86 + .../td/td/telegram/files/FileId.h | 68 + .../td/td/telegram/files/FileLoadManager.h | 34 + .../td/td/telegram/files/FileLoaderActor.h | 25 + .../td/td/telegram/files/FileLoaderUtils.h | 55 + .../td/td/telegram/files/FileLocation.h | 939 ++ .../td/td/telegram/files/FileManager.h | 982 ++ .../td/td/telegram/files/FileSourceId.h | 59 + .../td/td/telegram/files/FileStats.h | 114 + .../td/td/telegram/files/FileStatsWorker.h | 30 + .../td/td/telegram/files/FileType.h | 78 + .../td/td/telegram/files/FileUploadId.h | 58 + .../td/td/telegram/files/FileUploadManager.h | 123 + .../td/td/telegram/files/FileUploader.h | 124 + .../td/td/telegram/files/PartsManager.h | 114 + .../td/td/telegram/files/ResourceManager.h | 72 + .../td/td/telegram/files/ResourceState.h | 62 + .../td/td/telegram/logevent/LogEvent.h | 254 + .../td/td/telegram/logevent/LogEventHelper.h | 57 + .../td/td/telegram/logevent/SecretChatEvent.h | 521 + .../SharedHeaders/td/td/telegram/misc.h | 61 + .../td/td/telegram/net/AuthDataShared.h | 53 + .../td/td/telegram/net/AuthKeyState.h | 41 + .../td/td/telegram/net/ConnectionCreator.h | 281 + .../td/td/telegram/net/DcAuthManager.h | 71 + .../SharedHeaders/td/td/telegram/net/DcId.h | 118 + .../td/td/telegram/net/DcOptions.h | 252 + .../td/td/telegram/net/DcOptionsSet.h | 115 + .../td/td/telegram/net/MtprotoHeader.h | 122 + .../td/td/telegram/net/NetActor.h | 47 + .../td/td/telegram/net/NetQuery.h | 370 + .../td/td/telegram/net/NetQueryCounter.h | 40 + .../td/td/telegram/net/NetQueryCreator.h | 55 + .../td/td/telegram/net/NetQueryDelayer.h | 38 + .../td/td/telegram/net/NetQueryDispatcher.h | 101 + .../td/td/telegram/net/NetQueryStats.h | 49 + .../td/td/telegram/net/NetQueryVerifier.h | 48 + .../td/td/telegram/net/NetStatsManager.h | 209 + .../td/td/telegram/net/NetType.h | 53 + .../SharedHeaders/td/td/telegram/net/Proxy.h | 163 + .../td/telegram/net/PublicRsaKeySharedCdn.h | 59 + .../td/telegram/net/PublicRsaKeySharedMain.h | 33 + .../td/td/telegram/net/PublicRsaKeyWatchdog.h | 48 + .../td/td/telegram/net/Session.h | 289 + .../td/td/telegram/net/SessionMultiProxy.h | 63 + .../td/td/telegram/net/SessionProxy.h | 80 + .../td/td/telegram/net/TempAuthKeyWatchdog.h | 150 + .../td/td/telegram/td_c_client.h | 41 + .../td/td/telegram/td_json_client.h | 187 + .../SharedHeaders/td/td/telegram/td_log.h | 82 + .../SharedHeaders/td/td/tl/TlObject.h | 263 + .../SharedHeaders/td/td/tl/tl_dotnet_object.h | 205 + .../SharedHeaders/td/td/tl/tl_jni_object.h | 268 + .../SharedHeaders/td/td/tl/tl_json.h | 218 + .../SharedHeaders/td/td/tl/tl_object_parse.h | 147 + .../SharedHeaders/td/td/tl/tl_object_store.h | 86 + .../td/tdactor/td/actor/ConcurrentScheduler.h | 116 + .../td/tdactor/td/actor/MultiPromise.h | 120 + .../td/tdactor/td/actor/MultiTimeout.h | 81 + .../td/tdactor/td/actor/PromiseFuture.h | 324 + .../tdactor/td/actor/SchedulerLocalStorage.h | 81 + .../td/tdactor/td/actor/SignalSlot.h | 112 + .../td/tdactor/td/actor/SleepActor.h | 41 + .../td/tdactor/td/actor/Timeout.h | 68 + .../SharedHeaders/td/tdactor/td/actor/actor.h | 13 + .../td/tdactor/td/actor/impl/Actor-decl.h | 121 + .../td/tdactor/td/actor/impl/Actor.h | 167 + .../td/tdactor/td/actor/impl/ActorId-decl.h | 159 + .../td/tdactor/td/actor/impl/ActorId.h | 195 + .../td/tdactor/td/actor/impl/ActorInfo-decl.h | 128 + .../td/tdactor/td/actor/impl/ActorInfo.h | 209 + .../td/tdactor/td/actor/impl/Event.h | 247 + .../td/tdactor/td/actor/impl/EventFull-decl.h | 87 + .../td/tdactor/td/actor/impl/EventFull.h | 38 + .../td/tdactor/td/actor/impl/Scheduler-decl.h | 314 + .../td/tdactor/td/actor/impl/Scheduler.h | 370 + .../td/tddb/td/db/BinlogKeyValue.h | 301 + .../SharedHeaders/td/tddb/td/db/DbKey.h | 61 + .../td/tddb/td/db/KeyValueSyncInterface.h | 56 + .../SharedHeaders/td/tddb/td/db/SeqKeyValue.h | 105 + .../td/tddb/td/db/SqliteConnectionSafe.h | 39 + .../SharedHeaders/td/tddb/td/db/SqliteDb.h | 94 + .../td/tddb/td/db/SqliteKeyValue.h | 134 + .../td/tddb/td/db/SqliteKeyValueAsync.h | 38 + .../td/tddb/td/db/SqliteKeyValueSafe.h | 40 + .../td/tddb/td/db/SqliteStatement.h | 88 + .../SharedHeaders/td/tddb/td/db/TQueue.h | 157 + .../td/tddb/td/db/TsSeqKeyValue.h | 91 + .../td/tddb/td/db/binlog/Binlog.h | 183 + .../td/tddb/td/db/binlog/BinlogEvent.h | 115 + .../td/tddb/td/db/binlog/BinlogHelper.h | 32 + .../td/tddb/td/db/binlog/BinlogInterface.h | 90 + .../td/tddb/td/db/binlog/ConcurrentBinlog.h | 72 + .../td/db/binlog/detail/BinlogEventsBuffer.h | 51 + .../db/binlog/detail/BinlogEventsProcessor.h | 61 + .../td/tddb/td/db/detail/RawSqliteDb.h | 78 + .../SharedHeaders/td/tde2e/td/e2e/BitString.h | 62 + .../td/tde2e/td/e2e/Blockchain.h | 328 + .../SharedHeaders/td/tde2e/td/e2e/Call.h | 187 + .../td/tde2e/td/e2e/CheckSharedSecret.h | 32 + .../SharedHeaders/td/tde2e/td/e2e/Container.h | 255 + .../td/tde2e/td/e2e/DecryptedKey.h | 52 + .../td/tde2e/td/e2e/EncryptedKey.h | 28 + .../td/tde2e/td/e2e/EncryptedStorage.h | 411 + .../SharedHeaders/td/tde2e/td/e2e/Keys.h | 104 + .../td/tde2e/td/e2e/MessageEncryption.h | 36 + .../SharedHeaders/td/tde2e/td/e2e/Mnemonic.h | 59 + .../td/tde2e/td/e2e/QRHandshake.h | 91 + .../td/tde2e/td/e2e/TestBlockchain.h | 230 + .../SharedHeaders/td/tde2e/td/e2e/Trie.h | 97 + .../SharedHeaders/td/tde2e/td/e2e/bip39.h | 15 + .../SharedHeaders/td/tde2e/td/e2e/e2e_api.h | 355 + .../td/tde2e/td/e2e/e2e_errors.h | 66 + .../SharedHeaders/td/tde2e/td/e2e/utils.h | 120 + .../td/tdnet/td/net/DarwinHttp.h | 21 + .../td/tdnet/td/net/GetHostByNameActor.h | 76 + .../td/tdnet/td/net/HttpChunkedByteFlow.h | 29 + .../td/tdnet/td/net/HttpConnectionBase.h | 77 + .../tdnet/td/net/HttpContentLengthByteFlow.h | 25 + .../SharedHeaders/td/tdnet/td/net/HttpFile.h | 49 + .../td/tdnet/td/net/HttpHeaderCreator.h | 153 + .../td/tdnet/td/net/HttpInboundConnection.h | 44 + .../td/tdnet/td/net/HttpOutboundConnection.h | 49 + .../SharedHeaders/td/tdnet/td/net/HttpProxy.h | 28 + .../SharedHeaders/td/tdnet/td/net/HttpQuery.h | 50 + .../td/tdnet/td/net/HttpReader.h | 116 + .../SharedHeaders/td/tdnet/td/net/NetStats.h | 144 + .../SharedHeaders/td/tdnet/td/net/Socks5.h | 39 + .../SharedHeaders/td/tdnet/td/net/SslCtx.h | 45 + .../SharedHeaders/td/tdnet/td/net/SslStream.h | 46 + .../td/tdnet/td/net/TcpListener.h | 38 + .../td/tdnet/td/net/TransparentProxy.h | 57 + .../SharedHeaders/td/tdnet/td/net/Wget.h | 53 + .../SharedHeaders/td/tdtl/td/tl/tl_config.h | 87 + .../SharedHeaders/td/tdtl/td/tl/tl_core.h | 159 + .../td/tdtl/td/tl/tl_file_outputer.h | 33 + .../td/tdtl/td/tl/tl_file_utils.h | 21 + .../SharedHeaders/td/tdtl/td/tl/tl_generate.h | 28 + .../SharedHeaders/td/tdtl/td/tl/tl_outputer.h | 22 + .../SharedHeaders/td/tdtl/td/tl/tl_simple.h | 256 + .../td/tdtl/td/tl/tl_simple_parser.h | 107 + .../td/tdtl/td/tl/tl_string_outputer.h | 26 + .../SharedHeaders/td/tdtl/td/tl/tl_writer.h | 169 + .../td/tdutils/td/utils/AesCtrByteFlow.h | 51 + .../td/tdutils/td/utils/AsyncFileLog.h | 51 + .../td/tdutils/td/utils/AtomicRead.h | 89 + .../td/tdutils/td/utils/BigNum.h | 122 + .../td/tdutils/td/utils/BufferedFd.h | 231 + .../td/tdutils/td/utils/BufferedReader.h | 61 + .../td/tdutils/td/utils/BufferedUdp.h | 177 + .../td/tdutils/td/utils/ByteFlow.h | 389 + .../td/tdutils/td/utils/CancellationToken.h | 71 + .../td/tdutils/td/utils/ChainScheduler.h | 385 + .../td/tdutils/td/utils/ChangesProcessor.h | 61 + .../td/tdutils/td/utils/Closure.h | 119 + .../td/tdutils/td/utils/CombinedLog.h | 86 + .../td/tdutils/td/utils/ConcurrentHashTable.h | 321 + .../td/tdutils/td/utils/Container.h | 168 + .../td/tdutils/td/utils/Context.h | 44 + .../td/tdutils/td/utils/DecTree.h | 216 + .../td/tdutils/td/utils/Destructor.h | 52 + .../td/tdutils/td/utils/Ed25519.h | 97 + .../td/tdutils/td/utils/Enumerator.h | 55 + .../td/utils/EpochBasedMemoryReclamation.h | 201 + .../td/tdutils/td/utils/ExitGuard.h | 30 + .../td/tdutils/td/utils/FileLog.h | 54 + .../td/tdutils/td/utils/FlatHashMap.h | 24 + .../td/tdutils/td/utils/FlatHashMapChunks.h | 578 + .../td/tdutils/td/utils/FlatHashSet.h | 24 + .../td/tdutils/td/utils/FlatHashTable.h | 558 + .../td/tdutils/td/utils/FloodControlFast.h | 87 + .../td/tdutils/td/utils/FloodControlGlobal.h | 35 + .../td/tdutils/td/utils/FloodControlStrict.h | 97 + .../SharedHeaders/td/tdutils/td/utils/Gzip.h | 106 + .../td/tdutils/td/utils/GzipByteFlow.h | 46 + .../SharedHeaders/td/tdutils/td/utils/Hash.h | 70 + .../td/tdutils/td/utils/HashMap.h | 27 + .../td/tdutils/td/utils/HashSet.h | 27 + .../td/tdutils/td/utils/HashTableUtils.h | 76 + .../td/tdutils/td/utils/HazardPointers.h | 141 + .../SharedHeaders/td/tdutils/td/utils/Heap.h | 171 + .../SharedHeaders/td/tdutils/td/utils/Hints.h | 87 + .../td/tdutils/td/utils/HttpDate.h | 34 + .../td/tdutils/td/utils/HttpUrl.h | 64 + .../td/tdutils/td/utils/JsonBuilder.h | 895 ++ .../SharedHeaders/td/tdutils/td/utils/List.h | 129 + .../td/tdutils/td/utils/MapNode.h | 166 + .../td/tdutils/td/utils/MemoryLog.h | 79 + .../td/tdutils/td/utils/MimeType.h | 20 + .../td/tdutils/td/utils/MovableValue.h | 42 + .../td/tdutils/td/utils/MpmcQueue.h | 460 + .../td/tdutils/td/utils/MpmcWaiter.h | 332 + .../td/tdutils/td/utils/MpscLinkQueue.h | 173 + .../td/tdutils/td/utils/MpscPollableQueue.h | 159 + .../SharedHeaders/td/tdutils/td/utils/Named.h | 27 + .../td/tdutils/td/utils/NullLog.h | 19 + .../td/tdutils/td/utils/ObjectPool.h | 248 + .../td/tdutils/td/utils/Observer.h | 41 + .../td/tdutils/td/utils/OptionParser.h | 81 + .../tdutils/td/utils/OrderedEventsProcessor.h | 99 + .../td/tdutils/td/utils/Parser.h | 189 + .../td/tdutils/td/utils/PathView.h | 81 + .../td/tdutils/td/utils/Promise.h | 383 + .../td/tdutils/td/utils/Random.h | 68 + .../td/tdutils/td/utils/ScopeGuard.h | 77 + .../td/tdutils/td/utils/SetNode.h | 129 + .../td/tdutils/td/utils/SharedObjectPool.h | 288 + .../td/tdutils/td/utils/SharedSlice.h | 382 + .../td/tdutils/td/utils/Slice-decl.h | 212 + .../SharedHeaders/td/tdutils/td/utils/Slice.h | 323 + .../td/tdutils/td/utils/SliceBuilder.h | 57 + .../SharedHeaders/td/tdutils/td/utils/Span.h | 159 + .../td/tdutils/td/utils/SpinLock.h | 60 + .../td/tdutils/td/utils/StackAllocator.h | 61 + .../td/tdutils/td/utils/Status.h | 625 + .../td/tdutils/td/utils/StealingQueue.h | 125 + .../td/tdutils/td/utils/Storer.h | 88 + .../td/tdutils/td/utils/StorerBase.h | 25 + .../td/tdutils/td/utils/StringBuilder.h | 203 + .../td/tdutils/td/utils/ThreadLocalStorage.h | 55 + .../td/tdutils/td/utils/ThreadSafeCounter.h | 132 + .../SharedHeaders/td/tdutils/td/utils/Time.h | 106 + .../td/tdutils/td/utils/TimedStat.h | 97 + .../SharedHeaders/td/tdutils/td/utils/Timer.h | 50 + .../td/tdutils/td/utils/TlDowncastHelper.h | 29 + .../td/tdutils/td/utils/TlStorerToString.h | 152 + .../td/tdutils/td/utils/TsCerr.h | 33 + .../td/tdutils/td/utils/TsFileLog.h | 23 + .../td/tdutils/td/utils/TsList.h | 214 + .../SharedHeaders/td/tdutils/td/utils/TsLog.h | 55 + .../SharedHeaders/td/tdutils/td/utils/UInt.h | 92 + .../td/tdutils/td/utils/Variant.h | 298 + .../td/tdutils/td/utils/VectorQueue.h | 94 + .../td/tdutils/td/utils/WaitFreeHashMap.h | 190 + .../td/tdutils/td/utils/WaitFreeHashSet.h | 142 + .../td/tdutils/td/utils/WaitFreeVector.h | 69 + .../td/tdutils/td/utils/algorithm.h | 304 + .../SharedHeaders/td/tdutils/td/utils/as.h | 81 + .../td/tdutils/td/utils/base64.h | 35 + .../td/tdutils/td/utils/benchmark.h | 132 + .../SharedHeaders/td/tdutils/td/utils/bits.h | 310 + .../td/tdutils/td/utils/buffer.h | 836 ++ .../SharedHeaders/td/tdutils/td/utils/check.h | 34 + .../td/tdutils/td/utils/common.h | 127 + .../td/tdutils/td/utils/crypto.h | 184 + .../SharedHeaders/td/tdutils/td/utils/emoji.h | 32 + .../td/tdutils/td/utils/filesystem.h | 35 + .../td/tdutils/td/utils/find_boundary.h | 17 + .../td/tdutils/td/utils/fixed_vector.h | 79 + .../td/tdutils/td/utils/format.h | 303 + .../td/tdutils/td/utils/int_types.h | 45 + .../td/tdutils/td/utils/invoke.h | 210 + .../td/tdutils/td/utils/logging.h | 255 + .../SharedHeaders/td/tdutils/td/utils/misc.h | 354 + .../td/tdutils/td/utils/optional.h | 129 + .../td/tdutils/td/utils/overloaded.h | 39 + .../td/tdutils/td/utils/port/Clocks.h | 19 + .../td/tdutils/td/utils/port/CxCli.h | 162 + .../td/tdutils/td/utils/port/EventFd.h | 33 + .../td/tdutils/td/utils/port/EventFdBase.h | 32 + .../td/tdutils/td/utils/port/FileFd.h | 80 + .../td/tdutils/td/utils/port/FromApp.h | 100 + .../td/tdutils/td/utils/port/IPAddress.h | 97 + .../td/tdutils/td/utils/port/IoSlice.h | 42 + .../td/tdutils/td/utils/port/MemoryMapping.h | 52 + .../td/tdutils/td/utils/port/Mutex.h | 30 + .../td/tdutils/td/utils/port/Poll.h | 35 + .../td/tdutils/td/utils/port/PollBase.h | 28 + .../td/tdutils/td/utils/port/PollFlags.h | 122 + .../td/tdutils/td/utils/port/RwMutex.h | 148 + .../td/tdutils/td/utils/port/ServerSocketFd.h | 57 + .../td/tdutils/td/utils/port/SocketFd.h | 73 + .../td/tdutils/td/utils/port/Stat.h | 56 + .../td/tdutils/td/utils/port/StdStreams.h | 49 + .../td/tdutils/td/utils/port/UdpSocketFd.h | 90 + .../td/tdutils/td/utils/port/config.h | 59 + .../td/tdutils/td/utils/port/detail/Epoll.h | 59 + .../tdutils/td/utils/port/detail/EventFdBsd.h | 49 + .../td/utils/port/detail/EventFdLinux.h | 51 + .../td/utils/port/detail/EventFdWindows.h | 48 + .../td/tdutils/td/utils/port/detail/Iocp.h | 71 + .../td/tdutils/td/utils/port/detail/KQueue.h | 72 + .../tdutils/td/utils/port/detail/NativeFd.h | 73 + .../td/tdutils/td/utils/port/detail/Poll.h | 56 + .../tdutils/td/utils/port/detail/PollableFd.h | 230 + .../td/tdutils/td/utils/port/detail/Select.h | 64 + .../td/utils/port/detail/ThreadIdGuard.h | 26 + .../td/utils/port/detail/ThreadPthread.h | 113 + .../tdutils/td/utils/port/detail/ThreadStl.h | 153 + .../td/utils/port/detail/WineventPoll.h | 50 + .../tdutils/td/utils/port/detail/skip_eintr.h | 63 + .../td/tdutils/td/utils/port/path.h | 72 + .../td/tdutils/td/utils/port/platform.h | 121 + .../td/tdutils/td/utils/port/rlimit.h | 20 + .../td/tdutils/td/utils/port/signals.h | 36 + .../td/tdutils/td/utils/port/sleep.h | 15 + .../td/tdutils/td/utils/port/stacktrace.h | 23 + .../td/tdutils/td/utils/port/thread.h | 31 + .../td/tdutils/td/utils/port/thread_local.h | 65 + .../td/tdutils/td/utils/port/uname.h | 15 + .../td/tdutils/td/utils/port/user.h | 16 + .../tdutils/td/utils/port/wstring_convert.h | 31 + .../SharedHeaders/td/tdutils/td/utils/queue.h | 472 + .../td/tdutils/td/utils/simple_tests.h | 164 + .../SharedHeaders/td/tdutils/td/utils/tests.h | 220 + .../td/tdutils/td/utils/tl_helpers.h | 329 + .../td/tdutils/td/utils/tl_parsers.h | 243 + .../td/tdutils/td/utils/tl_storers.h | 160 + .../td/tdutils/td/utils/translit.h | 16 + .../td/tdutils/td/utils/type_traits.h | 46 + .../td/tdutils/td/utils/uint128.h | 293 + .../td/tdutils/td/utils/unicode.h | 33 + .../td/tdutils/td/utils/unique_ptr.h | 122 + .../td/tdutils/td/utils/unique_value_ptr.h | 93 + .../SharedHeaders/td/tdutils/td/utils/utf8.h | 118 + .../td/TdBinding/SharedHeaders/td/test/data.h | 24 + third-party/td/macos-cleanup.sh | 24 + 707 files changed, 103938 insertions(+), 2 deletions(-) create mode 100644 third-party/td/TdBinding/Package.swift create mode 100644 third-party/td/TdBinding/SharedHeaders/td/example/swift/src/td-Bridging-Header.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/memprof/memprof.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/memprof/memprof_stat.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3ext.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3session.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/crc32.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/portable_endian.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-parser-tree.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-parser.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-tl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/wgetopt.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_json_converter.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_c.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_cpp.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_dotnet.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_h.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_hpp.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_java.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_jni_cpp.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_jni_h.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_td.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/AuthData.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/AuthKey.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/ConnectionManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/CryptoStorer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/DhCallback.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/DhHandshake.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Handshake.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HandshakeActor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HandshakeConnection.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HttpTransport.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/IStreamTransport.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/KDF.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/MessageId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/MtprotoQuery.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/NoCryptoStorer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PacketInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PacketStorer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Ping.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PingConnection.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/ProxySecret.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/RSA.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/RawConnection.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/SessionConnection.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TcpTransport.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TlsInit.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TlsReaderByteFlow.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Transport.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TransportType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/mtproto/utils.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccentColorId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccessRights.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccountManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AffectedHistory.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AffiliateType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AlarmManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AnimationsManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Application.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AttachMenuManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AudiosManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AuthManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AutoDownloadSettings.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/AutosaveManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BackgroundId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BackgroundInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BackgroundManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BackgroundType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BaseTheme.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Birthdate.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BlockListId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BoostManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BotCommand.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BotCommandScope.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BotInfoManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BotMenuButton.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BotQueries.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BotRecommendationManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BotVerification.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BotVerifierSettings.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessAwayMessage.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessAwayMessageSchedule.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessBotManageBar.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessChatLink.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessConnectedBot.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessConnectionId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessConnectionManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessGreetingMessage.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessIntro.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessRecipients.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/BusinessWorkHours.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/CallActor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/CallDiscardReason.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/CallId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/CallManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/CallbackQueriesManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ChainId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ChannelId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ChannelParticipantFilter.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ChannelRecommendationManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ChannelType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ChatId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ChatManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ChatReactions.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Client.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ClientActor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ClientJson.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/CommonDialogManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ConfigManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ConnectionState.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ConnectionStateManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Contact.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/CountryInfoManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/CustomEmojiId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DelayDispatcher.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Dependencies.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DeviceTokenManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DhCache.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DhConfig.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogAction.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogActionBar.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogActionManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogAdministrator.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogBoostLinkInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogDate.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogDb.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogEventLog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogFilter.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogFilterDialogInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogFilterId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogFilterInviteLink.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogFilterManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogInviteLink.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogInviteLinkManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogListId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogLocation.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogNotificationSettings.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogParticipant.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogParticipantFilter.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogParticipantManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DialogSource.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Dimensions.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Document.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DocumentsManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DownloadManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DownloadManagerCallback.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/DraftMessage.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/EmailVerification.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/EmojiGroup.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/EmojiGroupType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/EmojiStatus.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/EncryptedFile.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/FactCheck.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/FileReferenceManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/FolderId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ForumTopic.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ForumTopicEditedData.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ForumTopicIcon.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ForumTopicInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ForumTopicManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Game.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/GameManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/GitCommitHash.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/GiveawayParameters.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Global.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/GlobalPrivacySettings.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/GroupCallId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/GroupCallManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/GroupCallParticipant.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/GroupCallParticipantOrder.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/GroupCallVideoPayload.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/HashtagHints.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/InlineMessageManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/InlineQueriesManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/InputBusinessChatLink.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/InputDialogId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/InputGroupCallId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/InputInvoice.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/InputMessageText.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/JsonValue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/LabeledPricePart.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/LanguagePackManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/LinkManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Location.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Log.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Logging.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MediaArea.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MediaAreaCoordinates.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageContent.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageContentType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageCopyOptions.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageDb.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageEffectId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageEntity.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageExtendedMedia.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageForwardInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageFullId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageImportManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageInputReplyTo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageLinkInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageOrigin.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageQueryManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageQuote.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageReaction.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageReactor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageReplyHeader.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageReplyInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageSearchFilter.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageSearchOffset.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageSelfDestructType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageSender.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageSource.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageThreadDb.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageThreadInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageTtl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessageViewer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessagesInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MessagesManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MinChannel.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/MissingInvitee.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NewPasswordState.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Notification.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationGroupFromDatabase.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationGroupId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationGroupInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationGroupKey.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationGroupType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationObjectFullId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationObjectId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationSettingsManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationSettingsScope.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationSound.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationSoundType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/NotificationType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/OnlineManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/OptionManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/OrderInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/OrderedMessage.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Outline.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PaidReactionType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PasswordManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Payments.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PeerColor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PeopleNearbyManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PhoneNumberManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Photo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PhotoFormat.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PhotoSize.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PhotoSizeSource.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PhotoSizeType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PollId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PollManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Premium.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PremiumGiftOption.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PrivacyManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PromoDataManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PtsManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/PublicDialogType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/QueryCombiner.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/QueryMerger.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/QuickReplyManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/QuickReplyMessageFullId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/QuickReplyShortcutId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReactionListType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReactionManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReactionNotificationSettings.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReactionNotificationsFrom.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReactionType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReactionUnavailabilityReason.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/RecentDialogList.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReferralProgramInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReferralProgramManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReferralProgramParameters.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReferralProgramSortOrder.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/RepliedMessageInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReplyMarkup.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ReportReason.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/RequestActor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/RequestedDialogType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Requests.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/RestrictionReason.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SavedMessagesManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SavedMessagesTopicId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ScheduledServerMessageId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ScopeNotificationSettings.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SecretChatActor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SecretChatDb.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SecretChatId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SecretChatLayer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SecretChatsManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SecretInputMedia.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SecureManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SecureStorage.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SecureValue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SendCodeHelper.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SentEmailCode.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SequenceDispatcher.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ServerMessageId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SetWithPosition.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SharedDialog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SpecialStickerSetType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SponsoredMessageManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StarAmount.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StarGift.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StarGiftAttribute.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StarGiftId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StarGiftManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StarManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StarSubscription.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StarSubscriptionPricing.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StateManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StatisticsManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StickerFormat.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StickerListType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StickerMaskPosition.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StickerPhotoSize.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StickerSetId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StickerType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StickersManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StorageManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryContent.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryContentType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryDb.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryForwardInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryFullId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryInteractionInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryListId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryNotificationSettings.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryStealthMode.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/StoryViewer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SuggestedAction.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SuggestedActionManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Support.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/SynchronousRequests.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TargetDialogTypes.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Td.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TdCallback.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TdDb.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TermsOfService.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TermsOfServiceManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ThemeManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/ThemeSettings.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TimeZoneManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TopDialogCategory.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TopDialogManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TranscriptionInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TranscriptionManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/TranslationManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/UniqueId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/UpdatesManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/UserId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/UserManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/UserPrivacySetting.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/UserPrivacySettingRule.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/UserStarGift.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Usernames.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Venue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/VerificationStatus.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/Version.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/VideoNotesManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/VideosManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/VoiceNotesManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/WebApp.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/WebAppManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/WebAppOpenParameters.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/WebPageBlock.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/WebPageId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/WebPagesManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileBitmask.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileData.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileDb.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileDbId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileDownloadManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileDownloader.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileEncryptionKey.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileFromBytes.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileGcParameters.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileGcWorker.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileGenerateManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileHashUploader.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileLoadManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileLoaderActor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileLoaderUtils.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileLocation.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileSourceId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileStats.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileStatsWorker.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileUploadId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileUploadManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/FileUploader.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/PartsManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/ResourceManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/files/ResourceState.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/logevent/LogEvent.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/logevent/LogEventHelper.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/logevent/SecretChatEvent.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/misc.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/AuthDataShared.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/AuthKeyState.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/ConnectionCreator.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/DcAuthManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/DcId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/DcOptions.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/DcOptionsSet.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/MtprotoHeader.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetActor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetQuery.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetQueryCounter.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetQueryCreator.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetQueryDelayer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetQueryDispatcher.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetQueryStats.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetQueryVerifier.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetStatsManager.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/NetType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/Proxy.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/PublicRsaKeySharedCdn.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/PublicRsaKeySharedMain.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/PublicRsaKeyWatchdog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/Session.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/SessionMultiProxy.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/SessionProxy.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/net/TempAuthKeyWatchdog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/td_c_client.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/td_json_client.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/telegram/td_log.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/tl/TlObject.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/tl/tl_dotnet_object.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/tl/tl_jni_object.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/tl/tl_json.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/tl/tl_object_parse.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/td/tl/tl_object_store.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/ConcurrentScheduler.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/MultiPromise.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/MultiTimeout.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/PromiseFuture.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/SchedulerLocalStorage.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/SignalSlot.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/SleepActor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/Timeout.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/actor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/Actor-decl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/Actor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/ActorId-decl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/ActorId.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/ActorInfo-decl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/ActorInfo.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/Event.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/EventFull-decl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/EventFull.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/Scheduler-decl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdactor/td/actor/impl/Scheduler.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/BinlogKeyValue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/DbKey.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/KeyValueSyncInterface.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/SeqKeyValue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/SqliteConnectionSafe.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/SqliteDb.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/SqliteKeyValue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/SqliteKeyValueAsync.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/SqliteKeyValueSafe.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/SqliteStatement.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/TQueue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/TsSeqKeyValue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/binlog/Binlog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/binlog/BinlogEvent.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/binlog/BinlogHelper.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/binlog/BinlogInterface.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/binlog/ConcurrentBinlog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/binlog/detail/BinlogEventsBuffer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/binlog/detail/BinlogEventsProcessor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tddb/td/db/detail/RawSqliteDb.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/BitString.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/Blockchain.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/Call.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/CheckSharedSecret.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/Container.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/DecryptedKey.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/EncryptedKey.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/EncryptedStorage.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/Keys.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/MessageEncryption.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/Mnemonic.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/QRHandshake.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/TestBlockchain.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/Trie.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/bip39.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/e2e_api.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/e2e_errors.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tde2e/td/e2e/utils.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/DarwinHttp.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/GetHostByNameActor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpChunkedByteFlow.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpConnectionBase.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpContentLengthByteFlow.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpFile.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpHeaderCreator.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpInboundConnection.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpOutboundConnection.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpProxy.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpQuery.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/HttpReader.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/NetStats.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/Socks5.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/SslCtx.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/SslStream.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/TcpListener.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/TransparentProxy.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdnet/td/net/Wget.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_config.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_core.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_file_outputer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_file_utils.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_generate.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_outputer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_simple.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_simple_parser.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_string_outputer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdtl/td/tl/tl_writer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/AesCtrByteFlow.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/AsyncFileLog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/AtomicRead.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/BigNum.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/BufferedFd.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/BufferedReader.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/BufferedUdp.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/ByteFlow.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/CancellationToken.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/ChainScheduler.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/ChangesProcessor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Closure.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/CombinedLog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/ConcurrentHashTable.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Container.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Context.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/DecTree.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Destructor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Ed25519.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Enumerator.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/EpochBasedMemoryReclamation.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/ExitGuard.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/FileLog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/FlatHashMap.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/FlatHashMapChunks.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/FlatHashSet.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/FlatHashTable.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/FloodControlFast.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/FloodControlGlobal.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/FloodControlStrict.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Gzip.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/GzipByteFlow.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Hash.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/HashMap.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/HashSet.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/HashTableUtils.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/HazardPointers.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Heap.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Hints.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/HttpDate.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/HttpUrl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/JsonBuilder.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/List.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/MapNode.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/MemoryLog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/MimeType.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/MovableValue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/MpmcQueue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/MpmcWaiter.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/MpscLinkQueue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/MpscPollableQueue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Named.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/NullLog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/ObjectPool.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Observer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/OptionParser.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/OrderedEventsProcessor.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Parser.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/PathView.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Promise.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Random.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/ScopeGuard.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/SetNode.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/SharedObjectPool.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/SharedSlice.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Slice-decl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Slice.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/SliceBuilder.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Span.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/SpinLock.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/StackAllocator.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Status.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/StealingQueue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Storer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/StorerBase.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/StringBuilder.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/ThreadLocalStorage.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/ThreadSafeCounter.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Time.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/TimedStat.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Timer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/TlDowncastHelper.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/TlStorerToString.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/TsCerr.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/TsFileLog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/TsList.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/TsLog.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/UInt.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/Variant.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/VectorQueue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/WaitFreeHashMap.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/WaitFreeHashSet.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/WaitFreeVector.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/algorithm.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/as.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/base64.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/benchmark.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/bits.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/buffer.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/check.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/common.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/crypto.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/emoji.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/filesystem.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/find_boundary.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/fixed_vector.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/format.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/int_types.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/invoke.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/logging.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/misc.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/optional.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/overloaded.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/Clocks.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/CxCli.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/EventFd.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/EventFdBase.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/FileFd.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/FromApp.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/IPAddress.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/IoSlice.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/MemoryMapping.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/Mutex.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/Poll.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/PollBase.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/PollFlags.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/RwMutex.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/ServerSocketFd.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/SocketFd.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/Stat.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/StdStreams.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/UdpSocketFd.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/config.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/Epoll.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/EventFdBsd.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/EventFdLinux.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/EventFdWindows.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/Iocp.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/KQueue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/NativeFd.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/Poll.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/PollableFd.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/Select.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/ThreadIdGuard.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/ThreadPthread.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/ThreadStl.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/WineventPoll.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/detail/skip_eintr.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/path.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/platform.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/rlimit.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/signals.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/sleep.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/stacktrace.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/thread.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/thread_local.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/uname.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/user.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/port/wstring_convert.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/queue.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/simple_tests.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/tests.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/tl_helpers.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/tl_parsers.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/tl_storers.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/translit.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/type_traits.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/uint128.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/unicode.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/unique_ptr.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/unique_value_ptr.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/tdutils/td/utils/utf8.h create mode 100644 third-party/td/TdBinding/SharedHeaders/td/test/data.h create mode 100755 third-party/td/macos-cleanup.sh diff --git a/submodules/TelegramVoip/Sources/GroupCallContext.swift b/submodules/TelegramVoip/Sources/GroupCallContext.swift index f731d15fed..93fe446b53 100644 --- a/submodules/TelegramVoip/Sources/GroupCallContext.swift +++ b/submodules/TelegramVoip/Sources/GroupCallContext.swift @@ -751,9 +751,9 @@ public final class OngoingGroupCallContext { encryptDecrypt: encryptionContext.flatMap { encryptionContext in return { data, isEncrypt in if isEncrypt { - return encryptionContext.encrypt(data) + return encryptionContext.encrypt(message: data) } else { - return encryptionContext.decrypt(data) + return encryptionContext.decrypt(message: data) } } } diff --git a/third-party/td/TdBinding/Package.swift b/third-party/td/TdBinding/Package.swift new file mode 100644 index 0000000000..186bb367e5 --- /dev/null +++ b/third-party/td/TdBinding/Package.swift @@ -0,0 +1,28 @@ +// swift-tools-version:5.5 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + + +let package = Package( + name: "TdBinding", + platforms: [ + .macOS(.v10_13) + ], + products: [ + .library( + name: "TdBinding", + targets: ["TdBinding"]), + ], + targets: [ + .target( + name: "TdBinding", + dependencies: [], + path: ".", + publicHeadersPath: "Public", + cxxSettings: [ + .headerSearchPath("SharedHeaders/td/tde2e"), + ]), + ], + cxxLanguageStandard: .cxx20 +) diff --git a/third-party/td/TdBinding/SharedHeaders/td/example/swift/src/td-Bridging-Header.h b/third-party/td/TdBinding/SharedHeaders/td/example/swift/src/td-Bridging-Header.h new file mode 100644 index 0000000000..981300ad42 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/example/swift/src/td-Bridging-Header.h @@ -0,0 +1,9 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// + +#include "td/telegram/td_json_client.h" +#include "td/telegram/td_log.h" diff --git a/third-party/td/TdBinding/SharedHeaders/td/memprof/memprof.h b/third-party/td/TdBinding/SharedHeaders/td/memprof/memprof.h new file mode 100644 index 0000000000..40d5512847 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/memprof/memprof.h @@ -0,0 +1,27 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include +#include +#include + +constexpr std::size_t BACKTRACE_SHIFT = 1; +constexpr std::size_t BACKTRACE_HASHED_LENGTH = 6; +constexpr std::size_t BACKTRACE_LENGTH = 10; + +using Backtrace = std::array; +struct AllocInfo { + Backtrace backtrace; + std::size_t size; +}; + +bool is_memprof_on(); +std::size_t get_ht_size(); +double get_fast_backtrace_success_rate(); +void dump_alloc(const std::function &func); +std::size_t get_used_memory_size(); diff --git a/third-party/td/TdBinding/SharedHeaders/td/memprof/memprof_stat.h b/third-party/td/TdBinding/SharedHeaders/td/memprof/memprof_stat.h new file mode 100644 index 0000000000..7328fa7459 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/memprof/memprof_stat.h @@ -0,0 +1,13 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include + +bool is_memprof_on(); + +std::size_t get_used_memory_size(); diff --git a/third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3.h b/third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3.h new file mode 100644 index 0000000000..44de2ee213 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3.h @@ -0,0 +1,12100 @@ +/* +** 2001-09-15 +** +** The author disclaims copyright to this source code. In place of +** a legal notice, here is a blessing: +** +** May you do good and not evil. +** May you find forgiveness for yourself and forgive others. +** May you share freely, never taking more than you give. +** +************************************************************************* +** This header file defines the interface that the SQLite library +** presents to client programs. If a C-function, structure, datatype, +** or constant definition does not appear in this file, then it is +** not a published API of SQLite, is subject to change without +** notice, and should not be referenced by programs that use SQLite. +** +** Some of the definitions that are in this file are marked as +** "experimental". Experimental interfaces are normally new +** features recently added to SQLite. We do not anticipate changes +** to experimental interfaces but reserve the right to make minor changes +** if experience from use "in the wild" suggest such changes are prudent. +** +** The official C-language API documentation for SQLite is derived +** from comments in this file. This file is the authoritative source +** on how SQLite interfaces are supposed to operate. +** +** The name of this file under configuration management is "sqlite.h.in". +** The makefile makes some minor changes to this file (such as inserting +** the version number) and changes its name to "sqlite3.h" as +** part of the build process. +*/ +#ifndef SQLITE3_H +#define SQLITE3_H +#include /* Needed for the definition of va_list */ + +/* +** Make sure we can call this stuff from C++. +*/ +#ifdef __cplusplus +extern "C" { +#endif + + +/* +** Provide the ability to override linkage features of the interface. +*/ +#ifndef SQLITE_EXTERN +# define SQLITE_EXTERN extern +#endif +#ifndef SQLITE_API +# define SQLITE_API +#endif +#ifndef SQLITE_CDECL +# define SQLITE_CDECL +#endif +#ifndef SQLITE_APICALL +# define SQLITE_APICALL +#endif +#ifndef SQLITE_STDCALL +# define SQLITE_STDCALL SQLITE_APICALL +#endif +#ifndef SQLITE_CALLBACK +# define SQLITE_CALLBACK +#endif +#ifndef SQLITE_SYSAPI +# define SQLITE_SYSAPI +#endif + +/* +** These no-op macros are used in front of interfaces to mark those +** interfaces as either deprecated or experimental. New applications +** should not use deprecated interfaces - they are supported for backwards +** compatibility only. Application writers should be aware that +** experimental interfaces are subject to change in point releases. +** +** These macros used to resolve to various kinds of compiler magic that +** would generate warning messages when they were used. But that +** compiler magic ended up generating such a flurry of bug reports +** that we have taken it all out and gone back to using simple +** noop macros. +*/ +#define SQLITE_DEPRECATED +#define SQLITE_EXPERIMENTAL + +/* +** Ensure these symbols were not defined by some previous header file. +*/ +#ifdef SQLITE_VERSION +# undef SQLITE_VERSION +#endif +#ifdef SQLITE_VERSION_NUMBER +# undef SQLITE_VERSION_NUMBER +#endif + +/* +** CAPI3REF: Compile-Time Library Version Numbers +** +** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header +** evaluates to a string literal that is the SQLite version in the +** format "X.Y.Z" where X is the major version number (always 3 for +** SQLite3) and Y is the minor version number and Z is the release number.)^ +** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer +** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same +** numbers used in [SQLITE_VERSION].)^ +** The SQLITE_VERSION_NUMBER for any given release of SQLite will also +** be larger than the release from which it is derived. Either Y will +** be held constant and Z will be incremented or else Y will be incremented +** and Z will be reset to zero. +** +** Since [version 3.6.18] ([dateof:3.6.18]), +** SQLite source code has been stored in the +** Fossil configuration management +** system. ^The SQLITE_SOURCE_ID macro evaluates to +** a string which identifies a particular check-in of SQLite +** within its configuration management system. ^The SQLITE_SOURCE_ID +** string contains the date and time of the check-in (UTC) and a SHA1 +** or SHA3-256 hash of the entire source tree. If the source code has +** been edited in any way since it was last checked in, then the last +** four hexadecimal digits of the hash may be modified. +** +** See also: [tdsqlite3_libversion()], +** [tdsqlite3_libversion_number()], [tdsqlite3_sourceid()], +** [sqlite_version()] and [sqlite_source_id()]. +*/ +#define SQLITE_VERSION "3.31.0" +#define SQLITE_VERSION_NUMBER 3031000 +#define SQLITE_SOURCE_ID "2020-01-22 18:38:59 f6affdd41608946fcfcea914ece149038a8b25a62bbe719ed2561c649b86alt1" + +/* +** CAPI3REF: Run-Time Library Version Numbers +** KEYWORDS: tdsqlite3_version tdsqlite3_sourceid +** +** These interfaces provide the same information as the [SQLITE_VERSION], +** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros +** but are associated with the library instead of the header file. ^(Cautious +** programmers might include assert() statements in their application to +** verify that values returned by these interfaces match the macros in +** the header, and thus ensure that the application is +** compiled with matching library and header files. +** +** 
+** assert( tdsqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
+** assert( strncmp(tdsqlite3_sourceid(),SQLITE_SOURCE_ID,80)==0 );
+** assert( strcmp(tdsqlite3_libversion(),SQLITE_VERSION)==0 );
+**
)^ +** +** ^The tdsqlite3_version[] string constant contains the text of [SQLITE_VERSION] +** macro. ^The tdsqlite3_libversion() function returns a pointer to the +** to the tdsqlite3_version[] string constant. The tdsqlite3_libversion() +** function is provided for use in DLLs since DLL users usually do not have +** direct access to string constants within the DLL. ^The +** tdsqlite3_libversion_number() function returns an integer equal to +** [SQLITE_VERSION_NUMBER]. ^(The tdsqlite3_sourceid() function returns +** a pointer to a string constant whose value is the same as the +** [SQLITE_SOURCE_ID] C preprocessor macro. Except if SQLite is built +** using an edited copy of [the amalgamation], then the last four characters +** of the hash might be different from [SQLITE_SOURCE_ID].)^ +** +** See also: [sqlite_version()] and [sqlite_source_id()]. +*/ +SQLITE_API SQLITE_EXTERN const char tdsqlite3_version[]; +SQLITE_API const char *tdsqlite3_libversion(void); +SQLITE_API const char *tdsqlite3_sourceid(void); +SQLITE_API int tdsqlite3_libversion_number(void); + +/* +** CAPI3REF: Run-Time Library Compilation Options Diagnostics +** +** ^The tdsqlite3_compileoption_used() function returns 0 or 1 +** indicating whether the specified option was defined at +** compile time. ^The SQLITE_ prefix may be omitted from the +** option name passed to tdsqlite3_compileoption_used(). +** +** ^The tdsqlite3_compileoption_get() function allows iterating +** over the list of options that were defined at compile time by +** returning the N-th compile time option string. ^If N is out of range, +** tdsqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_ +** prefix is omitted from any strings returned by +** tdsqlite3_compileoption_get(). +** +** ^Support for the diagnostic functions tdsqlite3_compileoption_used() +** and tdsqlite3_compileoption_get() may be omitted by specifying the +** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time. +** +** See also: SQL functions [sqlite_compileoption_used()] and +** [sqlite_compileoption_get()] and the [compile_options pragma]. +*/ +#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS +SQLITE_API int tdsqlite3_compileoption_used(const char *zOptName); +SQLITE_API const char *tdsqlite3_compileoption_get(int N); +#else +# define tdsqlite3_compileoption_used(X) 0 +# define tdsqlite3_compileoption_get(X) ((void*)0) +#endif + +/* +** CAPI3REF: Test To See If The Library Is Threadsafe +** +** ^The tdsqlite3_threadsafe() function returns zero if and only if +** SQLite was compiled with mutexing code omitted due to the +** [SQLITE_THREADSAFE] compile-time option being set to 0. +** +** SQLite can be compiled with or without mutexes. When +** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes +** are enabled and SQLite is threadsafe. When the +** [SQLITE_THREADSAFE] macro is 0, +** the mutexes are omitted. Without the mutexes, it is not safe +** to use SQLite concurrently from more than one thread. +** +** Enabling mutexes incurs a measurable performance penalty. +** So if speed is of utmost importance, it makes sense to disable +** the mutexes. But for maximum safety, mutexes should be enabled. +** ^The default behavior is for mutexes to be enabled. +** +** This interface can be used by an application to make sure that the +** version of SQLite that it is linking against was compiled with +** the desired setting of the [SQLITE_THREADSAFE] macro. +** +** This interface only reports on the compile-time mutex setting +** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with +** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but +** can be fully or partially disabled using a call to [tdsqlite3_config()] +** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD], +** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the +** tdsqlite3_threadsafe() function shows only the compile-time setting of +** thread safety, not any run-time changes to that setting made by +** tdsqlite3_config(). In other words, the return value from tdsqlite3_threadsafe() +** is unchanged by calls to tdsqlite3_config().)^ +** +** See the [threading mode] documentation for additional information. +*/ +SQLITE_API int tdsqlite3_threadsafe(void); + +/* +** CAPI3REF: Database Connection Handle +** KEYWORDS: {database connection} {database connections} +** +** Each open SQLite database is represented by a pointer to an instance of +** the opaque structure named "tdsqlite3". It is useful to think of an tdsqlite3 +** pointer as an object. The [tdsqlite3_open()], [tdsqlite3_open16()], and +** [tdsqlite3_open_v2()] interfaces are its constructors, and [tdsqlite3_close()] +** and [tdsqlite3_close_v2()] are its destructors. There are many other +** interfaces (such as +** [tdsqlite3_prepare_v2()], [tdsqlite3_create_function()], and +** [tdsqlite3_busy_timeout()] to name but three) that are methods on an +** tdsqlite3 object. +*/ +typedef struct tdsqlite3 tdsqlite3; + +/* +** CAPI3REF: 64-Bit Integer Types +** KEYWORDS: sqlite_int64 sqlite_uint64 +** +** Because there is no cross-platform way to specify 64-bit integer types +** SQLite includes typedefs for 64-bit signed and unsigned integers. +** +** The tdsqlite3_int64 and tdsqlite3_uint64 are the preferred type definitions. +** The sqlite_int64 and sqlite_uint64 types are supported for backwards +** compatibility only. +** +** ^The tdsqlite3_int64 and sqlite_int64 types can store integer values +** between -9223372036854775808 and +9223372036854775807 inclusive. ^The +** tdsqlite3_uint64 and sqlite_uint64 types can store integer values +** between 0 and +18446744073709551615 inclusive. +*/ +#ifdef SQLITE_INT64_TYPE + typedef SQLITE_INT64_TYPE sqlite_int64; +# ifdef SQLITE_UINT64_TYPE + typedef SQLITE_UINT64_TYPE sqlite_uint64; +# else + typedef unsigned SQLITE_INT64_TYPE sqlite_uint64; +# endif +#elif defined(_MSC_VER) || defined(__BORLANDC__) + typedef __int64 sqlite_int64; + typedef unsigned __int64 sqlite_uint64; +#else + typedef long long int sqlite_int64; + typedef unsigned long long int sqlite_uint64; +#endif +typedef sqlite_int64 tdsqlite3_int64; +typedef sqlite_uint64 tdsqlite3_uint64; + +/* +** If compiling for a processor that lacks floating point support, +** substitute integer for floating-point. +*/ +#ifdef SQLITE_OMIT_FLOATING_POINT +# define double tdsqlite3_int64 +#endif + +/* +** CAPI3REF: Closing A Database Connection +** DESTRUCTOR: tdsqlite3 +** +** ^The tdsqlite3_close() and tdsqlite3_close_v2() routines are destructors +** for the [tdsqlite3] object. +** ^Calls to tdsqlite3_close() and tdsqlite3_close_v2() return [SQLITE_OK] if +** the [tdsqlite3] object is successfully destroyed and all associated +** resources are deallocated. +** +** ^If the database connection is associated with unfinalized prepared +** statements or unfinished tdsqlite3_backup objects then tdsqlite3_close() +** will leave the database connection open and return [SQLITE_BUSY]. +** ^If tdsqlite3_close_v2() is called with unfinalized prepared statements +** and/or unfinished tdsqlite3_backups, then the database connection becomes +** an unusable "zombie" which will automatically be deallocated when the +** last prepared statement is finalized or the last tdsqlite3_backup is +** finished. The tdsqlite3_close_v2() interface is intended for use with +** host languages that are garbage collected, and where the order in which +** destructors are called is arbitrary. +** +** Applications should [tdsqlite3_finalize | finalize] all [prepared statements], +** [tdsqlite3_blob_close | close] all [BLOB handles], and +** [tdsqlite3_backup_finish | finish] all [tdsqlite3_backup] objects associated +** with the [tdsqlite3] object prior to attempting to close the object. ^If +** tdsqlite3_close_v2() is called on a [database connection] that still has +** outstanding [prepared statements], [BLOB handles], and/or +** [tdsqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation +** of resources is deferred until all [prepared statements], [BLOB handles], +** and [tdsqlite3_backup] objects are also destroyed. +** +** ^If an [tdsqlite3] object is destroyed while a transaction is open, +** the transaction is automatically rolled back. +** +** The C parameter to [tdsqlite3_close(C)] and [tdsqlite3_close_v2(C)] +** must be either a NULL +** pointer or an [tdsqlite3] object pointer obtained +** from [tdsqlite3_open()], [tdsqlite3_open16()], or +** [tdsqlite3_open_v2()], and not previously closed. +** ^Calling tdsqlite3_close() or tdsqlite3_close_v2() with a NULL pointer +** argument is a harmless no-op. +*/ +SQLITE_API int tdsqlite3_close(tdsqlite3*); +SQLITE_API int tdsqlite3_close_v2(tdsqlite3*); + +/* +** The type for a callback function. +** This is legacy and deprecated. It is included for historical +** compatibility and is not documented. +*/ +typedef int (*tdsqlite3_callback)(void*,int,char**, char**); + +/* +** CAPI3REF: One-Step Query Execution Interface +** METHOD: tdsqlite3 +** +** The tdsqlite3_exec() interface is a convenience wrapper around +** [tdsqlite3_prepare_v2()], [tdsqlite3_step()], and [tdsqlite3_finalize()], +** that allows an application to run multiple statements of SQL +** without having to use a lot of C code. +** +** ^The tdsqlite3_exec() interface runs zero or more UTF-8 encoded, +** semicolon-separate SQL statements passed into its 2nd argument, +** in the context of the [database connection] passed in as its 1st +** argument. ^If the callback function of the 3rd argument to +** tdsqlite3_exec() is not NULL, then it is invoked for each result row +** coming out of the evaluated SQL statements. ^The 4th argument to +** tdsqlite3_exec() is relayed through to the 1st argument of each +** callback invocation. ^If the callback pointer to tdsqlite3_exec() +** is NULL, then no callback is ever invoked and result rows are +** ignored. +** +** ^If an error occurs while evaluating the SQL statements passed into +** tdsqlite3_exec(), then execution of the current statement stops and +** subsequent statements are skipped. ^If the 5th parameter to tdsqlite3_exec() +** is not NULL then any error message is written into memory obtained +** from [tdsqlite3_malloc()] and passed back through the 5th parameter. +** To avoid memory leaks, the application should invoke [tdsqlite3_free()] +** on error message strings returned through the 5th parameter of +** tdsqlite3_exec() after the error message string is no longer needed. +** ^If the 5th parameter to tdsqlite3_exec() is not NULL and no errors +** occur, then tdsqlite3_exec() sets the pointer in its 5th parameter to +** NULL before returning. +** +** ^If an tdsqlite3_exec() callback returns non-zero, the tdsqlite3_exec() +** routine returns SQLITE_ABORT without invoking the callback again and +** without running any subsequent SQL statements. +** +** ^The 2nd argument to the tdsqlite3_exec() callback function is the +** number of columns in the result. ^The 3rd argument to the tdsqlite3_exec() +** callback is an array of pointers to strings obtained as if from +** [tdsqlite3_column_text()], one for each column. ^If an element of a +** result row is NULL then the corresponding string pointer for the +** tdsqlite3_exec() callback is a NULL pointer. ^The 4th argument to the +** tdsqlite3_exec() callback is an array of pointers to strings where each +** entry represents the name of corresponding result column as obtained +** from [tdsqlite3_column_name()]. +** +** ^If the 2nd parameter to tdsqlite3_exec() is a NULL pointer, a pointer +** to an empty string, or a pointer that contains only whitespace and/or +** SQL comments, then no SQL statements are evaluated and the database +** is not changed. +** +** Restrictions: +** +**
    +**
  • The application must ensure that the 1st parameter to tdsqlite3_exec() +** is a valid and open [database connection]. +**
  • The application must not close the [database connection] specified by +** the 1st parameter to tdsqlite3_exec() while tdsqlite3_exec() is running. +**
  • The application must not modify the SQL statement text passed into +** the 2nd parameter of tdsqlite3_exec() while tdsqlite3_exec() is running. +**
+*/ +SQLITE_API int tdsqlite3_exec( + tdsqlite3*, /* An open database */ + const char *sql, /* SQL to be evaluated */ + int (*callback)(void*,int,char**,char**), /* Callback function */ + void *, /* 1st argument to callback */ + char **errmsg /* Error msg written here */ +); + +/* +** CAPI3REF: Result Codes +** KEYWORDS: {result code definitions} +** +** Many SQLite functions return an integer result code from the set shown +** here in order to indicate success or failure. +** +** New error codes may be added in future versions of SQLite. +** +** See also: [extended result code definitions] +*/ +#define SQLITE_OK 0 /* Successful result */ +/* beginning-of-error-codes */ +#define SQLITE_ERROR 1 /* Generic error */ +#define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */ +#define SQLITE_PERM 3 /* Access permission denied */ +#define SQLITE_ABORT 4 /* Callback routine requested an abort */ +#define SQLITE_BUSY 5 /* The database file is locked */ +#define SQLITE_LOCKED 6 /* A table in the database is locked */ +#define SQLITE_NOMEM 7 /* A malloc() failed */ +#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ +#define SQLITE_INTERRUPT 9 /* Operation terminated by tdsqlite3_interrupt()*/ +#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ +#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ +#define SQLITE_NOTFOUND 12 /* Unknown opcode in tdsqlite3_file_control() */ +#define SQLITE_FULL 13 /* Insertion failed because database is full */ +#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ +#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ +#define SQLITE_EMPTY 16 /* Internal use only */ +#define SQLITE_SCHEMA 17 /* The database schema changed */ +#define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */ +#define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */ +#define SQLITE_MISMATCH 20 /* Data type mismatch */ +#define SQLITE_MISUSE 21 /* Library used incorrectly */ +#define SQLITE_NOLFS 22 /* Uses OS features not supported on host */ +#define SQLITE_AUTH 23 /* Authorization denied */ +#define SQLITE_FORMAT 24 /* Not used */ +#define SQLITE_RANGE 25 /* 2nd parameter to tdsqlite3_bind out of range */ +#define SQLITE_NOTADB 26 /* File opened that is not a database file */ +#define SQLITE_NOTICE 27 /* Notifications from tdsqlite3_log() */ +#define SQLITE_WARNING 28 /* Warnings from tdsqlite3_log() */ +#define SQLITE_ROW 100 /* tdsqlite3_step() has another row ready */ +#define SQLITE_DONE 101 /* tdsqlite3_step() has finished executing */ +/* end-of-error-codes */ + +/* +** CAPI3REF: Extended Result Codes +** KEYWORDS: {extended result code definitions} +** +** In its default configuration, SQLite API routines return one of 30 integer +** [result codes]. However, experience has shown that many of +** these result codes are too coarse-grained. They do not provide as +** much information about problems as programmers might like. In an effort to +** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8] +** and later) include +** support for additional result codes that provide more detailed information +** about errors. These [extended result codes] are enabled or disabled +** on a per database connection basis using the +** [tdsqlite3_extended_result_codes()] API. Or, the extended code for +** the most recent error can be obtained using +** [tdsqlite3_extended_errcode()]. +*/ +#define SQLITE_ERROR_MISSING_COLLSEQ (SQLITE_ERROR | (1<<8)) +#define SQLITE_ERROR_RETRY (SQLITE_ERROR | (2<<8)) +#define SQLITE_ERROR_SNAPSHOT (SQLITE_ERROR | (3<<8)) +#define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8)) +#define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8)) +#define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8)) +#define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8)) +#define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8)) +#define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8)) +#define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8)) +#define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8)) +#define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8)) +#define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8)) +#define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8)) +#define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8)) +#define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8)) +#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8)) +#define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8)) +#define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8)) +#define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8)) +#define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8)) +#define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8)) +#define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8)) +#define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8)) +#define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8)) +#define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8)) +#define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8)) +#define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8)) +#define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8)) +#define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8)) +#define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8)) +#define SQLITE_IOERR_BEGIN_ATOMIC (SQLITE_IOERR | (29<<8)) +#define SQLITE_IOERR_COMMIT_ATOMIC (SQLITE_IOERR | (30<<8)) +#define SQLITE_IOERR_ROLLBACK_ATOMIC (SQLITE_IOERR | (31<<8)) +#define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8)) +#define SQLITE_LOCKED_VTAB (SQLITE_LOCKED | (2<<8)) +#define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8)) +#define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8)) +#define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8)) +#define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8)) +#define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8)) +#define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8)) +#define SQLITE_CANTOPEN_DIRTYWAL (SQLITE_CANTOPEN | (5<<8)) /* Not Used */ +#define SQLITE_CANTOPEN_SYMLINK (SQLITE_CANTOPEN | (6<<8)) +#define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8)) +#define SQLITE_CORRUPT_SEQUENCE (SQLITE_CORRUPT | (2<<8)) +#define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8)) +#define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8)) +#define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8)) +#define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8)) +#define SQLITE_READONLY_CANTINIT (SQLITE_READONLY | (5<<8)) +#define SQLITE_READONLY_DIRECTORY (SQLITE_READONLY | (6<<8)) +#define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8)) +#define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8)) +#define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8)) +#define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8)) +#define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8)) +#define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8)) +#define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8)) +#define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8)) +#define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8)) +#define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8)) +#define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8)) +#define SQLITE_CONSTRAINT_PINNED (SQLITE_CONSTRAINT |(11<<8)) +#define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8)) +#define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8)) +#define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8)) +#define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8)) +#define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK | (1<<8)) +#define SQLITE_OK_SYMLINK (SQLITE_OK | (2<<8)) + +/* +** CAPI3REF: Flags For File Open Operations +** +** These bit values are intended for use in the +** 3rd parameter to the [tdsqlite3_open_v2()] interface and +** in the 4th parameter to the [tdsqlite3_vfs.xOpen] method. +*/ +#define SQLITE_OPEN_READONLY 0x00000001 /* Ok for tdsqlite3_open_v2() */ +#define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for tdsqlite3_open_v2() */ +#define SQLITE_OPEN_CREATE 0x00000004 /* Ok for tdsqlite3_open_v2() */ +#define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */ +#define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */ +#define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */ +#define SQLITE_OPEN_URI 0x00000040 /* Ok for tdsqlite3_open_v2() */ +#define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for tdsqlite3_open_v2() */ +#define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */ +#define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */ +#define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */ +#define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */ +#define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */ +#define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */ +#define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */ +#define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for tdsqlite3_open_v2() */ +#define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for tdsqlite3_open_v2() */ +#define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for tdsqlite3_open_v2() */ +#define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for tdsqlite3_open_v2() */ +#define SQLITE_OPEN_WAL 0x00080000 /* VFS only */ +#define SQLITE_OPEN_NOFOLLOW 0x01000000 /* Ok for tdsqlite3_open_v2() */ + +/* Reserved: 0x00F00000 */ + +/* +** CAPI3REF: Device Characteristics +** +** The xDeviceCharacteristics method of the [tdsqlite3_io_methods] +** object returns an integer which is a vector of these +** bit values expressing I/O characteristics of the mass storage +** device that holds the file that the [tdsqlite3_io_methods] +** refers to. +** +** The SQLITE_IOCAP_ATOMIC property means that all writes of +** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values +** mean that writes of blocks that are nnn bytes in size and +** are aligned to an address which is an integer multiple of +** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means +** that when data is appended to a file, the data is appended +** first then the size of the file is extended, never the other +** way around. The SQLITE_IOCAP_SEQUENTIAL property means that +** information is written to disk in the same order as calls +** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that +** after reboot following a crash or power loss, the only bytes in a +** file that were written at the application level might have changed +** and that adjacent bytes, even bytes within the same sector are +** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN +** flag indicates that a file cannot be deleted when open. The +** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on +** read-only media and cannot be changed even by processes with +** elevated privileges. +** +** The SQLITE_IOCAP_BATCH_ATOMIC property means that the underlying +** filesystem supports doing multiple write operations atomically when those +** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and +** [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. +*/ +#define SQLITE_IOCAP_ATOMIC 0x00000001 +#define SQLITE_IOCAP_ATOMIC512 0x00000002 +#define SQLITE_IOCAP_ATOMIC1K 0x00000004 +#define SQLITE_IOCAP_ATOMIC2K 0x00000008 +#define SQLITE_IOCAP_ATOMIC4K 0x00000010 +#define SQLITE_IOCAP_ATOMIC8K 0x00000020 +#define SQLITE_IOCAP_ATOMIC16K 0x00000040 +#define SQLITE_IOCAP_ATOMIC32K 0x00000080 +#define SQLITE_IOCAP_ATOMIC64K 0x00000100 +#define SQLITE_IOCAP_SAFE_APPEND 0x00000200 +#define SQLITE_IOCAP_SEQUENTIAL 0x00000400 +#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800 +#define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000 +#define SQLITE_IOCAP_IMMUTABLE 0x00002000 +#define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000 + +/* +** CAPI3REF: File Locking Levels +** +** SQLite uses one of these integer values as the second +** argument to calls it makes to the xLock() and xUnlock() methods +** of an [tdsqlite3_io_methods] object. +*/ +#define SQLITE_LOCK_NONE 0 +#define SQLITE_LOCK_SHARED 1 +#define SQLITE_LOCK_RESERVED 2 +#define SQLITE_LOCK_PENDING 3 +#define SQLITE_LOCK_EXCLUSIVE 4 + +/* +** CAPI3REF: Synchronization Type Flags +** +** When SQLite invokes the xSync() method of an +** [tdsqlite3_io_methods] object it uses a combination of +** these integer values as the second argument. +** +** When the SQLITE_SYNC_DATAONLY flag is used, it means that the +** sync operation only needs to flush data to mass storage. Inode +** information need not be flushed. If the lower four bits of the flag +** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics. +** If the lower four bits equal SQLITE_SYNC_FULL, that means +** to use Mac OS X style fullsync instead of fsync(). +** +** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags +** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL +** settings. The [synchronous pragma] determines when calls to the +** xSync VFS method occur and applies uniformly across all platforms. +** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how +** energetic or rigorous or forceful the sync operations are and +** only make a difference on Mac OSX for the default SQLite code. +** (Third-party VFS implementations might also make the distinction +** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the +** operating systems natively supported by SQLite, only Mac OSX +** cares about the difference.) +*/ +#define SQLITE_SYNC_NORMAL 0x00002 +#define SQLITE_SYNC_FULL 0x00003 +#define SQLITE_SYNC_DATAONLY 0x00010 + +/* +** CAPI3REF: OS Interface Open File Handle +** +** An [tdsqlite3_file] object represents an open file in the +** [tdsqlite3_vfs | OS interface layer]. Individual OS interface +** implementations will +** want to subclass this object by appending additional fields +** for their own use. The pMethods entry is a pointer to an +** [tdsqlite3_io_methods] object that defines methods for performing +** I/O operations on the open file. +*/ +typedef struct tdsqlite3_file tdsqlite3_file; +struct tdsqlite3_file { + const struct tdsqlite3_io_methods *pMethods; /* Methods for an open file */ +}; + +/* +** CAPI3REF: OS Interface File Virtual Methods Object +** +** Every file opened by the [tdsqlite3_vfs.xOpen] method populates an +** [tdsqlite3_file] object (or, more commonly, a subclass of the +** [tdsqlite3_file] object) with a pointer to an instance of this object. +** This object defines the methods used to perform various operations +** against the open file represented by the [tdsqlite3_file] object. +** +** If the [tdsqlite3_vfs.xOpen] method sets the tdsqlite3_file.pMethods element +** to a non-NULL pointer, then the tdsqlite3_io_methods.xClose method +** may be invoked even if the [tdsqlite3_vfs.xOpen] reported that it failed. The +** only way to prevent a call to xClose following a failed [tdsqlite3_vfs.xOpen] +** is for the [tdsqlite3_vfs.xOpen] to set the tdsqlite3_file.pMethods element +** to NULL. +** +** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or +** [SQLITE_SYNC_FULL]. The first choice is the normal fsync(). +** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY] +** flag may be ORed in to indicate that only the data of the file +** and not its inode needs to be synced. +** +** The integer values to xLock() and xUnlock() are one of +**
    +**
  • [SQLITE_LOCK_NONE], +**
  • [SQLITE_LOCK_SHARED], +**
  • [SQLITE_LOCK_RESERVED], +**
  • [SQLITE_LOCK_PENDING], or +**
  • [SQLITE_LOCK_EXCLUSIVE]. +**
+** xLock() increases the lock. xUnlock() decreases the lock. +** The xCheckReservedLock() method checks whether any database connection, +** either in this process or in some other process, is holding a RESERVED, +** PENDING, or EXCLUSIVE lock on the file. It returns true +** if such a lock exists and false otherwise. +** +** The xFileControl() method is a generic interface that allows custom +** VFS implementations to directly control an open file using the +** [tdsqlite3_file_control()] interface. The second "op" argument is an +** integer opcode. The third argument is a generic pointer intended to +** point to a structure that may contain arguments or space in which to +** write return values. Potential uses for xFileControl() might be +** functions to enable blocking locks with timeouts, to change the +** locking strategy (for example to use dot-file locks), to inquire +** about the status of a lock, or to break stale locks. The SQLite +** core reserves all opcodes less than 100 for its own use. +** A [file control opcodes | list of opcodes] less than 100 is available. +** Applications that define a custom xFileControl method should use opcodes +** greater than 100 to avoid conflicts. VFS implementations should +** return [SQLITE_NOTFOUND] for file control opcodes that they do not +** recognize. +** +** The xSectorSize() method returns the sector size of the +** device that underlies the file. The sector size is the +** minimum write that can be performed without disturbing +** other bytes in the file. The xDeviceCharacteristics() +** method returns a bit vector describing behaviors of the +** underlying device: +** +**
    +**
  • [SQLITE_IOCAP_ATOMIC] +**
  • [SQLITE_IOCAP_ATOMIC512] +**
  • [SQLITE_IOCAP_ATOMIC1K] +**
  • [SQLITE_IOCAP_ATOMIC2K] +**
  • [SQLITE_IOCAP_ATOMIC4K] +**
  • [SQLITE_IOCAP_ATOMIC8K] +**
  • [SQLITE_IOCAP_ATOMIC16K] +**
  • [SQLITE_IOCAP_ATOMIC32K] +**
  • [SQLITE_IOCAP_ATOMIC64K] +**
  • [SQLITE_IOCAP_SAFE_APPEND] +**
  • [SQLITE_IOCAP_SEQUENTIAL] +**
  • [SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN] +**
  • [SQLITE_IOCAP_POWERSAFE_OVERWRITE] +**
  • [SQLITE_IOCAP_IMMUTABLE] +**
  • [SQLITE_IOCAP_BATCH_ATOMIC] +**
+** +** The SQLITE_IOCAP_ATOMIC property means that all writes of +** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values +** mean that writes of blocks that are nnn bytes in size and +** are aligned to an address which is an integer multiple of +** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means +** that when data is appended to a file, the data is appended +** first then the size of the file is extended, never the other +** way around. The SQLITE_IOCAP_SEQUENTIAL property means that +** information is written to disk in the same order as calls +** to xWrite(). +** +** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill +** in the unread portions of the buffer with zeros. A VFS that +** fails to zero-fill short reads might seem to work. However, +** failure to zero-fill short reads will eventually lead to +** database corruption. +*/ +typedef struct tdsqlite3_io_methods tdsqlite3_io_methods; +struct tdsqlite3_io_methods { + int iVersion; + int (*xClose)(tdsqlite3_file*); + int (*xRead)(tdsqlite3_file*, void*, int iAmt, tdsqlite3_int64 iOfst); + int (*xWrite)(tdsqlite3_file*, const void*, int iAmt, tdsqlite3_int64 iOfst); + int (*xTruncate)(tdsqlite3_file*, tdsqlite3_int64 size); + int (*xSync)(tdsqlite3_file*, int flags); + int (*xFileSize)(tdsqlite3_file*, tdsqlite3_int64 *pSize); + int (*xLock)(tdsqlite3_file*, int); + int (*xUnlock)(tdsqlite3_file*, int); + int (*xCheckReservedLock)(tdsqlite3_file*, int *pResOut); + int (*xFileControl)(tdsqlite3_file*, int op, void *pArg); + int (*xSectorSize)(tdsqlite3_file*); + int (*xDeviceCharacteristics)(tdsqlite3_file*); + /* Methods above are valid for version 1 */ + int (*xShmMap)(tdsqlite3_file*, int iPg, int pgsz, int, void volatile**); + int (*xShmLock)(tdsqlite3_file*, int offset, int n, int flags); + void (*xShmBarrier)(tdsqlite3_file*); + int (*xShmUnmap)(tdsqlite3_file*, int deleteFlag); + /* Methods above are valid for version 2 */ + int (*xFetch)(tdsqlite3_file*, tdsqlite3_int64 iOfst, int iAmt, void **pp); + int (*xUnfetch)(tdsqlite3_file*, tdsqlite3_int64 iOfst, void *p); + /* Methods above are valid for version 3 */ + /* Additional methods may be added in future releases */ +}; + +/* +** CAPI3REF: Standard File Control Opcodes +** KEYWORDS: {file control opcodes} {file control opcode} +** +** These integer constants are opcodes for the xFileControl method +** of the [tdsqlite3_io_methods] object and for the [tdsqlite3_file_control()] +** interface. +** +**
    +**
  • [[SQLITE_FCNTL_LOCKSTATE]] +** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This +** opcode causes the xFileControl method to write the current state of +** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED], +** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE]) +** into an integer that the pArg argument points to. This capability +** is used during testing and is only available when the SQLITE_TEST +** compile-time option is used. +** +**
  • [[SQLITE_FCNTL_SIZE_HINT]] +** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS +** layer a hint of how large the database file will grow to be during the +** current transaction. This hint is not guaranteed to be accurate but it +** is often close. The underlying VFS might choose to preallocate database +** file space based on this hint in order to help writes to the database +** file run faster. +** +**
  • [[SQLITE_FCNTL_SIZE_LIMIT]] +** The [SQLITE_FCNTL_SIZE_LIMIT] opcode is used by in-memory VFS that +** implements [tdsqlite3_deserialize()] to set an upper bound on the size +** of the in-memory database. The argument is a pointer to a [tdsqlite3_int64]. +** If the integer pointed to is negative, then it is filled in with the +** current limit. Otherwise the limit is set to the larger of the value +** of the integer pointed to and the current database size. The integer +** pointed to is set to the new limit. +** +**
  • [[SQLITE_FCNTL_CHUNK_SIZE]] +** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS +** extends and truncates the database file in chunks of a size specified +** by the user. The fourth argument to [tdsqlite3_file_control()] should +** point to an integer (type int) containing the new chunk-size to use +** for the nominated database. Allocating database file space in large +** chunks (say 1MB at a time), may reduce file-system fragmentation and +** improve performance on some systems. +** +**
  • [[SQLITE_FCNTL_FILE_POINTER]] +** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer +** to the [tdsqlite3_file] object associated with a particular database +** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER]. +** +**
  • [[SQLITE_FCNTL_JOURNAL_POINTER]] +** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer +** to the [tdsqlite3_file] object associated with the journal file (either +** the [rollback journal] or the [write-ahead log]) for a particular database +** connection. See also [SQLITE_FCNTL_FILE_POINTER]. +** +**
  • [[SQLITE_FCNTL_SYNC_OMITTED]] +** No longer in use. +** +**
  • [[SQLITE_FCNTL_SYNC]] +** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and +** sent to the VFS immediately before the xSync method is invoked on a +** database file descriptor. Or, if the xSync method is not invoked +** because the user has configured SQLite with +** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place +** of the xSync method. In most cases, the pointer argument passed with +** this file-control is NULL. However, if the database file is being synced +** as part of a multi-database commit, the argument points to a nul-terminated +** string containing the transactions master-journal file name. VFSes that +** do not need this signal should silently ignore this opcode. Applications +** should not call [tdsqlite3_file_control()] with this opcode as doing so may +** disrupt the operation of the specialized VFSes that do require it. +** +**
  • [[SQLITE_FCNTL_COMMIT_PHASETWO]] +** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite +** and sent to the VFS after a transaction has been committed immediately +** but before the database is unlocked. VFSes that do not need this signal +** should silently ignore this opcode. Applications should not call +** [tdsqlite3_file_control()] with this opcode as doing so may disrupt the +** operation of the specialized VFSes that do require it. +** +**
  • [[SQLITE_FCNTL_WIN32_AV_RETRY]] +** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic +** retry counts and intervals for certain disk I/O operations for the +** windows [VFS] in order to provide robustness in the presence of +** anti-virus programs. By default, the windows VFS will retry file read, +** file write, and file delete operations up to 10 times, with a delay +** of 25 milliseconds before the first retry and with the delay increasing +** by an additional 25 milliseconds with each subsequent retry. This +** opcode allows these two values (10 retries and 25 milliseconds of delay) +** to be adjusted. The values are changed for all database connections +** within the same process. The argument is a pointer to an array of two +** integers where the first integer is the new retry count and the second +** integer is the delay. If either integer is negative, then the setting +** is not changed but instead the prior value of that setting is written +** into the array entry, allowing the current retry settings to be +** interrogated. The zDbName parameter is ignored. +** +**
  • [[SQLITE_FCNTL_PERSIST_WAL]] +** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the +** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary +** write ahead log ([WAL file]) and shared memory +** files used for transaction control +** are automatically deleted when the latest connection to the database +** closes. Setting persistent WAL mode causes those files to persist after +** close. Persisting the files is useful when other processes that do not +** have write permission on the directory containing the database file want +** to read the database file, as the WAL and shared memory files must exist +** in order for the database to be readable. The fourth parameter to +** [tdsqlite3_file_control()] for this opcode should be a pointer to an integer. +** That integer is 0 to disable persistent WAL mode or 1 to enable persistent +** WAL mode. If the integer is -1, then it is overwritten with the current +** WAL persistence setting. +** +**
  • [[SQLITE_FCNTL_POWERSAFE_OVERWRITE]] +** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the +** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting +** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the +** xDeviceCharacteristics methods. The fourth parameter to +** [tdsqlite3_file_control()] for this opcode should be a pointer to an integer. +** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage +** mode. If the integer is -1, then it is overwritten with the current +** zero-damage mode setting. +** +**
  • [[SQLITE_FCNTL_OVERWRITE]] +** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening +** a write transaction to indicate that, unless it is rolled back for some +** reason, the entire database file will be overwritten by the current +** transaction. This is used by VACUUM operations. +** +**
  • [[SQLITE_FCNTL_VFSNAME]] +** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of +** all [VFSes] in the VFS stack. The names are of all VFS shims and the +** final bottom-level VFS are written into memory obtained from +** [tdsqlite3_malloc()] and the result is stored in the char* variable +** that the fourth parameter of [tdsqlite3_file_control()] points to. +** The caller is responsible for freeing the memory when done. As with +** all file-control actions, there is no guarantee that this will actually +** do anything. Callers should initialize the char* variable to a NULL +** pointer in case this file-control is not implemented. This file-control +** is intended for diagnostic use only. +** +**
  • [[SQLITE_FCNTL_VFS_POINTER]] +** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level +** [VFSes] currently in use. ^(The argument X in +** tdsqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be +** of type "[tdsqlite3_vfs] **". This opcodes will set *X +** to a pointer to the top-level VFS.)^ +** ^When there are multiple VFS shims in the stack, this opcode finds the +** upper-most shim only. +** +**
  • [[SQLITE_FCNTL_PRAGMA]] +** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA] +** file control is sent to the open [tdsqlite3_file] object corresponding +** to the database file to which the pragma statement refers. ^The argument +** to the [SQLITE_FCNTL_PRAGMA] file control is an array of +** pointers to strings (char**) in which the second element of the array +** is the name of the pragma and the third element is the argument to the +** pragma or NULL if the pragma has no argument. ^The handler for an +** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element +** of the char** argument point to a string obtained from [tdsqlite3_mprintf()] +** or the equivalent and that string will become the result of the pragma or +** the error message if the pragma fails. ^If the +** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal +** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA] +** file control returns [SQLITE_OK], then the parser assumes that the +** VFS has handled the PRAGMA itself and the parser generates a no-op +** prepared statement if result string is NULL, or that returns a copy +** of the result string if the string is non-NULL. +** ^If the [SQLITE_FCNTL_PRAGMA] file control returns +** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means +** that the VFS encountered an error while handling the [PRAGMA] and the +** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA] +** file control occurs at the beginning of pragma statement analysis and so +** it is able to override built-in [PRAGMA] statements. +** +**
  • [[SQLITE_FCNTL_BUSYHANDLER]] +** ^The [SQLITE_FCNTL_BUSYHANDLER] +** file-control may be invoked by SQLite on the database file handle +** shortly after it is opened in order to provide a custom VFS with access +** to the connection's busy-handler callback. The argument is of type (void**) +** - an array of two (void *) values. The first (void *) actually points +** to a function of type (int (*)(void *)). In order to invoke the connection's +** busy-handler, this function should be invoked with the second (void *) in +** the array as the only argument. If it returns non-zero, then the operation +** should be retried. If it returns zero, the custom VFS should abandon the +** current operation. +** +**
  • [[SQLITE_FCNTL_TEMPFILENAME]] +** ^Applications can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control +** to have SQLite generate a +** temporary filename using the same algorithm that is followed to generate +** temporary filenames for TEMP tables and other internal uses. The +** argument should be a char** which will be filled with the filename +** written into memory obtained from [tdsqlite3_malloc()]. The caller should +** invoke [tdsqlite3_free()] on the result to avoid a memory leak. +** +**
  • [[SQLITE_FCNTL_MMAP_SIZE]] +** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the +** maximum number of bytes that will be used for memory-mapped I/O. +** The argument is a pointer to a value of type tdsqlite3_int64 that +** is an advisory maximum number of bytes in the file to memory map. The +** pointer is overwritten with the old value. The limit is not changed if +** the value originally pointed to is negative, and so the current limit +** can be queried by passing in a pointer to a negative number. This +** file-control is used internally to implement [PRAGMA mmap_size]. +** +**
  • [[SQLITE_FCNTL_TRACE]] +** The [SQLITE_FCNTL_TRACE] file control provides advisory information +** to the VFS about what the higher layers of the SQLite stack are doing. +** This file control is used by some VFS activity tracing [shims]. +** The argument is a zero-terminated string. Higher layers in the +** SQLite stack may generate instances of this file control if +** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled. +** +**
  • [[SQLITE_FCNTL_HAS_MOVED]] +** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a +** pointer to an integer and it writes a boolean into that integer depending +** on whether or not the file has been renamed, moved, or deleted since it +** was first opened. +** +**
  • [[SQLITE_FCNTL_WIN32_GET_HANDLE]] +** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the +** underlying native file handle associated with a file handle. This file +** control interprets its argument as a pointer to a native file handle and +** writes the resulting value there. +** +**
  • [[SQLITE_FCNTL_WIN32_SET_HANDLE]] +** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This +** opcode causes the xFileControl method to swap the file handle with the one +** pointed to by the pArg argument. This capability is used during testing +** and only needs to be supported when SQLITE_TEST is defined. +** +**
  • [[SQLITE_FCNTL_WAL_BLOCK]] +** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might +** be advantageous to block on the next WAL lock if the lock is not immediately +** available. The WAL subsystem issues this signal during rare +** circumstances in order to fix a problem with priority inversion. +** Applications should not use this file-control. +** +**
  • [[SQLITE_FCNTL_ZIPVFS]] +** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other +** VFS should return SQLITE_NOTFOUND for this opcode. +** +**
  • [[SQLITE_FCNTL_RBU]] +** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by +** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for +** this opcode. +** +**
  • [[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]] +** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then +** the file descriptor is placed in "batch write mode", which +** means all subsequent write operations will be deferred and done +** atomically at the next [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. Systems +** that do not support batch atomic writes will return SQLITE_NOTFOUND. +** ^Following a successful SQLITE_FCNTL_BEGIN_ATOMIC_WRITE and prior to +** the closing [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] or +** [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE], SQLite will make +** no VFS interface calls on the same [tdsqlite3_file] file descriptor +** except for calls to the xWrite method and the xFileControl method +** with [SQLITE_FCNTL_SIZE_HINT]. +** +**
  • [[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]] +** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write +** operations since the previous successful call to +** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically. +** This file control returns [SQLITE_OK] if and only if the writes were +** all performed successfully and have been committed to persistent storage. +** ^Regardless of whether or not it is successful, this file control takes +** the file descriptor out of batch write mode so that all subsequent +** write operations are independent. +** ^SQLite will never invoke SQLITE_FCNTL_COMMIT_ATOMIC_WRITE without +** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]. +** +**
  • [[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]] +** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write +** operations since the previous successful call to +** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back. +** ^This file control takes the file descriptor out of batch write mode +** so that all subsequent write operations are independent. +** ^SQLite will never invoke SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE without +** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]. +** +**
  • [[SQLITE_FCNTL_LOCK_TIMEOUT]] +** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode causes attempts to obtain +** a file lock using the xLock or xShmLock methods of the VFS to wait +** for up to M milliseconds before failing, where M is the single +** unsigned integer parameter. +** +**
  • [[SQLITE_FCNTL_DATA_VERSION]] +** The [SQLITE_FCNTL_DATA_VERSION] opcode is used to detect changes to +** a database file. The argument is a pointer to a 32-bit unsigned integer. +** The "data version" for the pager is written into the pointer. The +** "data version" changes whenever any change occurs to the corresponding +** database file, either through SQL statements on the same database +** connection or through transactions committed by separate database +** connections possibly in other processes. The [tdsqlite3_total_changes()] +** interface can be used to find if any database on the connection has changed, +** but that interface responds to changes on TEMP as well as MAIN and does +** not provide a mechanism to detect changes to MAIN only. Also, the +** [tdsqlite3_total_changes()] interface responds to internal changes only and +** omits changes made by other database connections. The +** [PRAGMA data_version] command provides a mechanism to detect changes to +** a single attached database that occur due to other database connections, +** but omits changes implemented by the database connection on which it is +** called. This file control is the only mechanism to detect changes that +** happen either internally or externally and that are associated with +** a particular attached database. +** +**
  • [[SQLITE_FCNTL_CKPT_DONE]] +** The [SQLITE_FCNTL_CKPT_DONE] opcode is invoked from within a checkpoint +** in wal mode after the client has finished copying pages from the wal +** file to the database file, but before the *-shm file is updated to +** record the fact that the pages have been checkpointed. +**
+*/ +#define SQLITE_FCNTL_LOCKSTATE 1 +#define SQLITE_FCNTL_GET_LOCKPROXYFILE 2 +#define SQLITE_FCNTL_SET_LOCKPROXYFILE 3 +#define SQLITE_FCNTL_LAST_ERRNO 4 +#define SQLITE_FCNTL_SIZE_HINT 5 +#define SQLITE_FCNTL_CHUNK_SIZE 6 +#define SQLITE_FCNTL_FILE_POINTER 7 +#define SQLITE_FCNTL_SYNC_OMITTED 8 +#define SQLITE_FCNTL_WIN32_AV_RETRY 9 +#define SQLITE_FCNTL_PERSIST_WAL 10 +#define SQLITE_FCNTL_OVERWRITE 11 +#define SQLITE_FCNTL_VFSNAME 12 +#define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13 +#define SQLITE_FCNTL_PRAGMA 14 +#define SQLITE_FCNTL_BUSYHANDLER 15 +#define SQLITE_FCNTL_TEMPFILENAME 16 +#define SQLITE_FCNTL_MMAP_SIZE 18 +#define SQLITE_FCNTL_TRACE 19 +#define SQLITE_FCNTL_HAS_MOVED 20 +#define SQLITE_FCNTL_SYNC 21 +#define SQLITE_FCNTL_COMMIT_PHASETWO 22 +#define SQLITE_FCNTL_WIN32_SET_HANDLE 23 +#define SQLITE_FCNTL_WAL_BLOCK 24 +#define SQLITE_FCNTL_ZIPVFS 25 +#define SQLITE_FCNTL_RBU 26 +#define SQLITE_FCNTL_VFS_POINTER 27 +#define SQLITE_FCNTL_JOURNAL_POINTER 28 +#define SQLITE_FCNTL_WIN32_GET_HANDLE 29 +#define SQLITE_FCNTL_PDB 30 +#define SQLITE_FCNTL_BEGIN_ATOMIC_WRITE 31 +#define SQLITE_FCNTL_COMMIT_ATOMIC_WRITE 32 +#define SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE 33 +#define SQLITE_FCNTL_LOCK_TIMEOUT 34 +#define SQLITE_FCNTL_DATA_VERSION 35 +#define SQLITE_FCNTL_SIZE_LIMIT 36 +#define SQLITE_FCNTL_CKPT_DONE 37 + +/* deprecated names */ +#define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE +#define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE +#define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO + + +/* +** CAPI3REF: Mutex Handle +** +** The mutex module within SQLite defines [tdsqlite3_mutex] to be an +** abstract type for a mutex object. The SQLite core never looks +** at the internal representation of an [tdsqlite3_mutex]. It only +** deals with pointers to the [tdsqlite3_mutex] object. +** +** Mutexes are created using [tdsqlite3_mutex_alloc()]. +*/ +typedef struct tdsqlite3_mutex tdsqlite3_mutex; + +/* +** CAPI3REF: Loadable Extension Thunk +** +** A pointer to the opaque tdsqlite3_api_routines structure is passed as +** the third parameter to entry points of [loadable extensions]. This +** structure must be typedefed in order to work around compiler warnings +** on some platforms. +*/ +typedef struct tdsqlite3_api_routines tdsqlite3_api_routines; + +/* +** CAPI3REF: OS Interface Object +** +** An instance of the tdsqlite3_vfs object defines the interface between +** the SQLite core and the underlying operating system. The "vfs" +** in the name of the object stands for "virtual file system". See +** the [VFS | VFS documentation] for further information. +** +** The VFS interface is sometimes extended by adding new methods onto +** the end. Each time such an extension occurs, the iVersion field +** is incremented. The iVersion value started out as 1 in +** SQLite [version 3.5.0] on [dateof:3.5.0], then increased to 2 +** with SQLite [version 3.7.0] on [dateof:3.7.0], and then increased +** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6]. Additional fields +** may be appended to the tdsqlite3_vfs object and the iVersion value +** may increase again in future versions of SQLite. +** Note that due to an oversight, the structure +** of the tdsqlite3_vfs object changed in the transition from +** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0] +** and yet the iVersion field was not increased. +** +** The szOsFile field is the size of the subclassed [tdsqlite3_file] +** structure used by this VFS. mxPathname is the maximum length of +** a pathname in this VFS. +** +** Registered tdsqlite3_vfs objects are kept on a linked list formed by +** the pNext pointer. The [tdsqlite3_vfs_register()] +** and [tdsqlite3_vfs_unregister()] interfaces manage this list +** in a thread-safe way. The [tdsqlite3_vfs_find()] interface +** searches the list. Neither the application code nor the VFS +** implementation should use the pNext pointer. +** +** The pNext field is the only field in the tdsqlite3_vfs +** structure that SQLite will ever modify. SQLite will only access +** or modify this field while holding a particular static mutex. +** The application should never modify anything within the tdsqlite3_vfs +** object once the object has been registered. +** +** The zName field holds the name of the VFS module. The name must +** be unique across all VFS modules. +** +** [[tdsqlite3_vfs.xOpen]] +** ^SQLite guarantees that the zFilename parameter to xOpen +** is either a NULL pointer or string obtained +** from xFullPathname() with an optional suffix added. +** ^If a suffix is added to the zFilename parameter, it will +** consist of a single "-" character followed by no more than +** 11 alphanumeric and/or "-" characters. +** ^SQLite further guarantees that +** the string will be valid and unchanged until xClose() is +** called. Because of the previous sentence, +** the [tdsqlite3_file] can safely store a pointer to the +** filename if it needs to remember the filename for some reason. +** If the zFilename parameter to xOpen is a NULL pointer then xOpen +** must invent its own temporary name for the file. ^Whenever the +** xFilename parameter is NULL it will also be the case that the +** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE]. +** +** The flags argument to xOpen() includes all bits set in +** the flags argument to [tdsqlite3_open_v2()]. Or if [tdsqlite3_open()] +** or [tdsqlite3_open16()] is used, then flags includes at least +** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. +** If xOpen() opens a file read-only then it sets *pOutFlags to +** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set. +** +** ^(SQLite will also add one of the following flags to the xOpen() +** call, depending on the object being opened: +** +**
    +**
  • [SQLITE_OPEN_MAIN_DB] +**
  • [SQLITE_OPEN_MAIN_JOURNAL] +**
  • [SQLITE_OPEN_TEMP_DB] +**
  • [SQLITE_OPEN_TEMP_JOURNAL] +**
  • [SQLITE_OPEN_TRANSIENT_DB] +**
  • [SQLITE_OPEN_SUBJOURNAL] +**
  • [SQLITE_OPEN_MASTER_JOURNAL] +**
  • [SQLITE_OPEN_WAL] +**
)^ +** +** The file I/O implementation can use the object type flags to +** change the way it deals with files. For example, an application +** that does not care about crash recovery or rollback might make +** the open of a journal file a no-op. Writes to this journal would +** also be no-ops, and any attempt to read the journal would return +** SQLITE_IOERR. Or the implementation might recognize that a database +** file will be doing page-aligned sector reads and writes in a random +** order and set up its I/O subsystem accordingly. +** +** SQLite might also add one of the following flags to the xOpen method: +** +**
    +**
  • [SQLITE_OPEN_DELETEONCLOSE] +**
  • [SQLITE_OPEN_EXCLUSIVE] +**
+** +** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be +** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE] +** will be set for TEMP databases and their journals, transient +** databases, and subjournals. +** +** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction +** with the [SQLITE_OPEN_CREATE] flag, which are both directly +** analogous to the O_EXCL and O_CREAT flags of the POSIX open() +** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the +** SQLITE_OPEN_CREATE, is used to indicate that file should always +** be created, and that it is an error if it already exists. +** It is not used to indicate the file should be opened +** for exclusive access. +** +** ^At least szOsFile bytes of memory are allocated by SQLite +** to hold the [tdsqlite3_file] structure passed as the third +** argument to xOpen. The xOpen method does not have to +** allocate the structure; it should just fill it in. Note that +** the xOpen method must set the tdsqlite3_file.pMethods to either +** a valid [tdsqlite3_io_methods] object or to NULL. xOpen must do +** this even if the open fails. SQLite expects that the tdsqlite3_file.pMethods +** element will be valid after xOpen returns regardless of the success +** or failure of the xOpen call. +** +** [[tdsqlite3_vfs.xAccess]] +** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS] +** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to +** test whether a file is readable and writable, or [SQLITE_ACCESS_READ] +** to test whether a file is at least readable. The SQLITE_ACCESS_READ +** flag is never actually used and is not implemented in the built-in +** VFSes of SQLite. The file is named by the second argument and can be a +** directory. The xAccess method returns [SQLITE_OK] on success or some +** non-zero error code if there is an I/O error or if the name of +** the file given in the second argument is illegal. If SQLITE_OK +** is returned, then non-zero or zero is written into *pResOut to indicate +** whether or not the file is accessible. +** +** ^SQLite will always allocate at least mxPathname+1 bytes for the +** output buffer xFullPathname. The exact size of the output buffer +** is also passed as a parameter to both methods. If the output buffer +** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is +** handled as a fatal error by SQLite, vfs implementations should endeavor +** to prevent this by setting mxPathname to a sufficiently large value. +** +** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64() +** interfaces are not strictly a part of the filesystem, but they are +** included in the VFS structure for completeness. +** The xRandomness() function attempts to return nBytes bytes +** of good-quality randomness into zOut. The return value is +** the actual number of bytes of randomness obtained. +** The xSleep() method causes the calling thread to sleep for at +** least the number of microseconds given. ^The xCurrentTime() +** method returns a Julian Day Number for the current date and time as +** a floating point value. +** ^The xCurrentTimeInt64() method returns, as an integer, the Julian +** Day Number multiplied by 86400000 (the number of milliseconds in +** a 24-hour day). +** ^SQLite will use the xCurrentTimeInt64() method to get the current +** date and time if that method is available (if iVersion is 2 or +** greater and the function pointer is not NULL) and will fall back +** to xCurrentTime() if xCurrentTimeInt64() is unavailable. +** +** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces +** are not used by the SQLite core. These optional interfaces are provided +** by some VFSes to facilitate testing of the VFS code. By overriding +** system calls with functions under its control, a test program can +** simulate faults and error conditions that would otherwise be difficult +** or impossible to induce. The set of system calls that can be overridden +** varies from one VFS to another, and from one version of the same VFS to the +** next. Applications that use these interfaces must be prepared for any +** or all of these interfaces to be NULL or for their behavior to change +** from one release to the next. Applications must not attempt to access +** any of these methods if the iVersion of the VFS is less than 3. +*/ +typedef struct tdsqlite3_vfs tdsqlite3_vfs; +typedef void (*tdsqlite3_syscall_ptr)(void); +struct tdsqlite3_vfs { + int iVersion; /* Structure version number (currently 3) */ + int szOsFile; /* Size of subclassed tdsqlite3_file */ + int mxPathname; /* Maximum file pathname length */ + tdsqlite3_vfs *pNext; /* Next registered VFS */ + const char *zName; /* Name of this virtual file system */ + void *pAppData; /* Pointer to application-specific data */ + int (*xOpen)(tdsqlite3_vfs*, const char *zName, tdsqlite3_file*, + int flags, int *pOutFlags); + int (*xDelete)(tdsqlite3_vfs*, const char *zName, int syncDir); + int (*xAccess)(tdsqlite3_vfs*, const char *zName, int flags, int *pResOut); + int (*xFullPathname)(tdsqlite3_vfs*, const char *zName, int nOut, char *zOut); + void *(*xDlOpen)(tdsqlite3_vfs*, const char *zFilename); + void (*xDlError)(tdsqlite3_vfs*, int nByte, char *zErrMsg); + void (*(*xDlSym)(tdsqlite3_vfs*,void*, const char *zSymbol))(void); + void (*xDlClose)(tdsqlite3_vfs*, void*); + int (*xRandomness)(tdsqlite3_vfs*, int nByte, char *zOut); + int (*xSleep)(tdsqlite3_vfs*, int microseconds); + int (*xCurrentTime)(tdsqlite3_vfs*, double*); + int (*xGetLastError)(tdsqlite3_vfs*, int, char *); + /* + ** The methods above are in version 1 of the sqlite_vfs object + ** definition. Those that follow are added in version 2 or later + */ + int (*xCurrentTimeInt64)(tdsqlite3_vfs*, tdsqlite3_int64*); + /* + ** The methods above are in versions 1 and 2 of the sqlite_vfs object. + ** Those below are for version 3 and greater. + */ + int (*xSetSystemCall)(tdsqlite3_vfs*, const char *zName, tdsqlite3_syscall_ptr); + tdsqlite3_syscall_ptr (*xGetSystemCall)(tdsqlite3_vfs*, const char *zName); + const char *(*xNextSystemCall)(tdsqlite3_vfs*, const char *zName); + /* + ** The methods above are in versions 1 through 3 of the sqlite_vfs object. + ** New fields may be appended in future versions. The iVersion + ** value will increment whenever this happens. + */ +}; + +/* +** CAPI3REF: Flags for the xAccess VFS method +** +** These integer constants can be used as the third parameter to +** the xAccess method of an [tdsqlite3_vfs] object. They determine +** what kind of permissions the xAccess method is looking for. +** With SQLITE_ACCESS_EXISTS, the xAccess method +** simply checks whether the file exists. +** With SQLITE_ACCESS_READWRITE, the xAccess method +** checks whether the named directory is both readable and writable +** (in other words, if files can be added, removed, and renamed within +** the directory). +** The SQLITE_ACCESS_READWRITE constant is currently used only by the +** [temp_store_directory pragma], though this could change in a future +** release of SQLite. +** With SQLITE_ACCESS_READ, the xAccess method +** checks whether the file is readable. The SQLITE_ACCESS_READ constant is +** currently unused, though it might be used in a future release of +** SQLite. +*/ +#define SQLITE_ACCESS_EXISTS 0 +#define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */ +#define SQLITE_ACCESS_READ 2 /* Unused */ + +/* +** CAPI3REF: Flags for the xShmLock VFS method +** +** These integer constants define the various locking operations +** allowed by the xShmLock method of [tdsqlite3_io_methods]. The +** following are the only legal combinations of flags to the +** xShmLock method: +** +**
    +**
  • SQLITE_SHM_LOCK | SQLITE_SHM_SHARED +**
  • SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE +**
  • SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED +**
  • SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE +**
+** +** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as +** was given on the corresponding lock. +** +** The xShmLock method can transition between unlocked and SHARED or +** between unlocked and EXCLUSIVE. It cannot transition between SHARED +** and EXCLUSIVE. +*/ +#define SQLITE_SHM_UNLOCK 1 +#define SQLITE_SHM_LOCK 2 +#define SQLITE_SHM_SHARED 4 +#define SQLITE_SHM_EXCLUSIVE 8 + +/* +** CAPI3REF: Maximum xShmLock index +** +** The xShmLock method on [tdsqlite3_io_methods] may use values +** between 0 and this upper bound as its "offset" argument. +** The SQLite core will never attempt to acquire or release a +** lock outside of this range +*/ +#define SQLITE_SHM_NLOCK 8 + + +/* +** CAPI3REF: Initialize The SQLite Library +** +** ^The tdsqlite3_initialize() routine initializes the +** SQLite library. ^The tdsqlite3_shutdown() routine +** deallocates any resources that were allocated by tdsqlite3_initialize(). +** These routines are designed to aid in process initialization and +** shutdown on embedded systems. Workstation applications using +** SQLite normally do not need to invoke either of these routines. +** +** A call to tdsqlite3_initialize() is an "effective" call if it is +** the first time tdsqlite3_initialize() is invoked during the lifetime of +** the process, or if it is the first time tdsqlite3_initialize() is invoked +** following a call to tdsqlite3_shutdown(). ^(Only an effective call +** of tdsqlite3_initialize() does any initialization. All other calls +** are harmless no-ops.)^ +** +** A call to tdsqlite3_shutdown() is an "effective" call if it is the first +** call to tdsqlite3_shutdown() since the last tdsqlite3_initialize(). ^(Only +** an effective call to tdsqlite3_shutdown() does any deinitialization. +** All other valid calls to tdsqlite3_shutdown() are harmless no-ops.)^ +** +** The tdsqlite3_initialize() interface is threadsafe, but tdsqlite3_shutdown() +** is not. The tdsqlite3_shutdown() interface must only be called from a +** single thread. All open [database connections] must be closed and all +** other SQLite resources must be deallocated prior to invoking +** tdsqlite3_shutdown(). +** +** Among other things, ^tdsqlite3_initialize() will invoke +** tdsqlite3_os_init(). Similarly, ^tdsqlite3_shutdown() +** will invoke tdsqlite3_os_end(). +** +** ^The tdsqlite3_initialize() routine returns [SQLITE_OK] on success. +** ^If for some reason, tdsqlite3_initialize() is unable to initialize +** the library (perhaps it is unable to allocate a needed resource such +** as a mutex) it returns an [error code] other than [SQLITE_OK]. +** +** ^The tdsqlite3_initialize() routine is called internally by many other +** SQLite interfaces so that an application usually does not need to +** invoke tdsqlite3_initialize() directly. For example, [tdsqlite3_open()] +** calls tdsqlite3_initialize() so the SQLite library will be automatically +** initialized when [tdsqlite3_open()] is called if it has not be initialized +** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT] +** compile-time option, then the automatic calls to tdsqlite3_initialize() +** are omitted and the application must call tdsqlite3_initialize() directly +** prior to using any other SQLite interface. For maximum portability, +** it is recommended that applications always invoke tdsqlite3_initialize() +** directly prior to using any other SQLite interface. Future releases +** of SQLite may require this. In other words, the behavior exhibited +** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the +** default behavior in some future release of SQLite. +** +** The tdsqlite3_os_init() routine does operating-system specific +** initialization of the SQLite library. The tdsqlite3_os_end() +** routine undoes the effect of tdsqlite3_os_init(). Typical tasks +** performed by these routines include allocation or deallocation +** of static resources, initialization of global variables, +** setting up a default [tdsqlite3_vfs] module, or setting up +** a default configuration using [tdsqlite3_config()]. +** +** The application should never invoke either tdsqlite3_os_init() +** or tdsqlite3_os_end() directly. The application should only invoke +** tdsqlite3_initialize() and tdsqlite3_shutdown(). The tdsqlite3_os_init() +** interface is called automatically by tdsqlite3_initialize() and +** tdsqlite3_os_end() is called by tdsqlite3_shutdown(). Appropriate +** implementations for tdsqlite3_os_init() and tdsqlite3_os_end() +** are built into SQLite when it is compiled for Unix, Windows, or OS/2. +** When [custom builds | built for other platforms] +** (using the [SQLITE_OS_OTHER=1] compile-time +** option) the application must supply a suitable implementation for +** tdsqlite3_os_init() and tdsqlite3_os_end(). An application-supplied +** implementation of tdsqlite3_os_init() or tdsqlite3_os_end() +** must return [SQLITE_OK] on success and some other [error code] upon +** failure. +*/ +SQLITE_API int tdsqlite3_initialize(void); +SQLITE_API int tdsqlite3_shutdown(void); +SQLITE_API int tdsqlite3_os_init(void); +SQLITE_API int tdsqlite3_os_end(void); + +/* +** CAPI3REF: Configuring The SQLite Library +** +** The tdsqlite3_config() interface is used to make global configuration +** changes to SQLite in order to tune SQLite to the specific needs of +** the application. The default configuration is recommended for most +** applications and so this routine is usually not necessary. It is +** provided to support rare applications with unusual needs. +** +** The tdsqlite3_config() interface is not threadsafe. The application +** must ensure that no other SQLite interfaces are invoked by other +** threads while tdsqlite3_config() is running. +** +** The tdsqlite3_config() interface +** may only be invoked prior to library initialization using +** [tdsqlite3_initialize()] or after shutdown by [tdsqlite3_shutdown()]. +** ^If tdsqlite3_config() is called after [tdsqlite3_initialize()] and before +** [tdsqlite3_shutdown()] then it will return SQLITE_MISUSE. +** Note, however, that ^tdsqlite3_config() can be called as part of the +** implementation of an application-defined [tdsqlite3_os_init()]. +** +** The first argument to tdsqlite3_config() is an integer +** [configuration option] that determines +** what property of SQLite is to be configured. Subsequent arguments +** vary depending on the [configuration option] +** in the first argument. +** +** ^When a configuration option is set, tdsqlite3_config() returns [SQLITE_OK]. +** ^If the option is unknown or SQLite is unable to set the option +** then this routine returns a non-zero [error code]. +*/ +SQLITE_API int tdsqlite3_config(int, ...); + +/* +** CAPI3REF: Configure database connections +** METHOD: tdsqlite3 +** +** The tdsqlite3_db_config() interface is used to make configuration +** changes to a [database connection]. The interface is similar to +** [tdsqlite3_config()] except that the changes apply to a single +** [database connection] (specified in the first argument). +** +** The second argument to tdsqlite3_db_config(D,V,...) is the +** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code +** that indicates what aspect of the [database connection] is being configured. +** Subsequent arguments vary depending on the configuration verb. +** +** ^Calls to tdsqlite3_db_config() return SQLITE_OK if and only if +** the call is considered successful. +*/ +SQLITE_API int tdsqlite3_db_config(tdsqlite3*, int op, ...); + +/* +** CAPI3REF: Memory Allocation Routines +** +** An instance of this object defines the interface between SQLite +** and low-level memory allocation routines. +** +** This object is used in only one place in the SQLite interface. +** A pointer to an instance of this object is the argument to +** [tdsqlite3_config()] when the configuration option is +** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC]. +** By creating an instance of this object +** and passing it to [tdsqlite3_config]([SQLITE_CONFIG_MALLOC]) +** during configuration, an application can specify an alternative +** memory allocation subsystem for SQLite to use for all of its +** dynamic memory needs. +** +** Note that SQLite comes with several [built-in memory allocators] +** that are perfectly adequate for the overwhelming majority of applications +** and that this object is only useful to a tiny minority of applications +** with specialized memory allocation requirements. This object is +** also used during testing of SQLite in order to specify an alternative +** memory allocator that simulates memory out-of-memory conditions in +** order to verify that SQLite recovers gracefully from such +** conditions. +** +** The xMalloc, xRealloc, and xFree methods must work like the +** malloc(), realloc() and free() functions from the standard C library. +** ^SQLite guarantees that the second argument to +** xRealloc is always a value returned by a prior call to xRoundup. +** +** xSize should return the allocated size of a memory allocation +** previously obtained from xMalloc or xRealloc. The allocated size +** is always at least as big as the requested size but may be larger. +** +** The xRoundup method returns what would be the allocated size of +** a memory allocation given a particular requested size. Most memory +** allocators round up memory allocations at least to the next multiple +** of 8. Some allocators round up to a larger multiple or to a power of 2. +** Every memory allocation request coming in through [tdsqlite3_malloc()] +** or [tdsqlite3_realloc()] first calls xRoundup. If xRoundup returns 0, +** that causes the corresponding memory allocation to fail. +** +** The xInit method initializes the memory allocator. For example, +** it might allocate any required mutexes or initialize internal data +** structures. The xShutdown method is invoked (indirectly) by +** [tdsqlite3_shutdown()] and should deallocate any resources acquired +** by xInit. The pAppData pointer is used as the only parameter to +** xInit and xShutdown. +** +** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes +** the xInit method, so the xInit method need not be threadsafe. The +** xShutdown method is only called from [tdsqlite3_shutdown()] so it does +** not need to be threadsafe either. For all other methods, SQLite +** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the +** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which +** it is by default) and so the methods are automatically serialized. +** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other +** methods must be threadsafe or else make their own arrangements for +** serialization. +** +** SQLite will never invoke xInit() more than once without an intervening +** call to xShutdown(). +*/ +typedef struct tdsqlite3_mem_methods tdsqlite3_mem_methods; +struct tdsqlite3_mem_methods { + void *(*xMalloc)(int); /* Memory allocation function */ + void (*xFree)(void*); /* Free a prior allocation */ + void *(*xRealloc)(void*,int); /* Resize an allocation */ + int (*xSize)(void*); /* Return the size of an allocation */ + int (*xRoundup)(int); /* Round up request size to allocation size */ + int (*xInit)(void*); /* Initialize the memory allocator */ + void (*xShutdown)(void*); /* Deinitialize the memory allocator */ + void *pAppData; /* Argument to xInit() and xShutdown() */ +}; + +/* +** CAPI3REF: Configuration Options +** KEYWORDS: {configuration option} +** +** These constants are the available integer configuration options that +** can be passed as the first argument to the [tdsqlite3_config()] interface. +** +** New configuration options may be added in future releases of SQLite. +** Existing configuration options might be discontinued. Applications +** should check the return code from [tdsqlite3_config()] to make sure that +** the call worked. The [tdsqlite3_config()] interface will return a +** non-zero [error code] if a discontinued or unsupported configuration option +** is invoked. +** +**
+** [[SQLITE_CONFIG_SINGLETHREAD]]
SQLITE_CONFIG_SINGLETHREAD
+**
There are no arguments to this option. ^This option sets the +** [threading mode] to Single-thread. In other words, it disables +** all mutexing and puts SQLite into a mode where it can only be used +** by a single thread. ^If SQLite is compiled with +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then +** it is not possible to change the [threading mode] from its default +** value of Single-thread and so [tdsqlite3_config()] will return +** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD +** configuration option.
+** +** [[SQLITE_CONFIG_MULTITHREAD]]
SQLITE_CONFIG_MULTITHREAD
+**
There are no arguments to this option. ^This option sets the +** [threading mode] to Multi-thread. In other words, it disables +** mutexing on [database connection] and [prepared statement] objects. +** The application is responsible for serializing access to +** [database connections] and [prepared statements]. But other mutexes +** are enabled so that SQLite will be safe to use in a multi-threaded +** environment as long as no two threads attempt to use the same +** [database connection] at the same time. ^If SQLite is compiled with +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then +** it is not possible to set the Multi-thread [threading mode] and +** [tdsqlite3_config()] will return [SQLITE_ERROR] if called with the +** SQLITE_CONFIG_MULTITHREAD configuration option.
+** +** [[SQLITE_CONFIG_SERIALIZED]]
SQLITE_CONFIG_SERIALIZED
+**
There are no arguments to this option. ^This option sets the +** [threading mode] to Serialized. In other words, this option enables +** all mutexes including the recursive +** mutexes on [database connection] and [prepared statement] objects. +** In this mode (which is the default when SQLite is compiled with +** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access +** to [database connections] and [prepared statements] so that the +** application is free to use the same [database connection] or the +** same [prepared statement] in different threads at the same time. +** ^If SQLite is compiled with +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then +** it is not possible to set the Serialized [threading mode] and +** [tdsqlite3_config()] will return [SQLITE_ERROR] if called with the +** SQLITE_CONFIG_SERIALIZED configuration option.
+** +** [[SQLITE_CONFIG_MALLOC]]
SQLITE_CONFIG_MALLOC
+**
^(The SQLITE_CONFIG_MALLOC option takes a single argument which is +** a pointer to an instance of the [tdsqlite3_mem_methods] structure. +** The argument specifies +** alternative low-level memory allocation routines to be used in place of +** the memory allocation routines built into SQLite.)^ ^SQLite makes +** its own private copy of the content of the [tdsqlite3_mem_methods] structure +** before the [tdsqlite3_config()] call returns.
+** +** [[SQLITE_CONFIG_GETMALLOC]]
SQLITE_CONFIG_GETMALLOC
+**
^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which +** is a pointer to an instance of the [tdsqlite3_mem_methods] structure. +** The [tdsqlite3_mem_methods] +** structure is filled with the currently defined memory allocation routines.)^ +** This option can be used to overload the default memory allocation +** routines with a wrapper that simulations memory allocation failure or +** tracks memory usage, for example.
+** +** [[SQLITE_CONFIG_SMALL_MALLOC]]
SQLITE_CONFIG_SMALL_MALLOC
+**
^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of +** type int, interpreted as a boolean, which if true provides a hint to +** SQLite that it should avoid large memory allocations if possible. +** SQLite will run faster if it is free to make large memory allocations, +** but some application might prefer to run slower in exchange for +** guarantees about memory fragmentation that are possible if large +** allocations are avoided. This hint is normally off. +**
+** +** [[SQLITE_CONFIG_MEMSTATUS]]
SQLITE_CONFIG_MEMSTATUS
+**
^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int, +** interpreted as a boolean, which enables or disables the collection of +** memory allocation statistics. ^(When memory allocation statistics are +** disabled, the following SQLite interfaces become non-operational: +**
    +**
  • [tdsqlite3_hard_heap_limit64()] +**
  • [tdsqlite3_memory_used()] +**
  • [tdsqlite3_memory_highwater()] +**
  • [tdsqlite3_soft_heap_limit64()] +**
  • [tdsqlite3_status64()] +**
)^ +** ^Memory allocation statistics are enabled by default unless SQLite is +** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory +** allocation statistics are disabled by default. +**
+** +** [[SQLITE_CONFIG_SCRATCH]]
SQLITE_CONFIG_SCRATCH
+**
The SQLITE_CONFIG_SCRATCH option is no longer used. +**
+** +** [[SQLITE_CONFIG_PAGECACHE]]
SQLITE_CONFIG_PAGECACHE
+**
^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool +** that SQLite can use for the database page cache with the default page +** cache implementation. +** This configuration option is a no-op if an application-defined page +** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2]. +** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to +** 8-byte aligned memory (pMem), the size of each page cache line (sz), +** and the number of cache lines (N). +** The sz argument should be the size of the largest database page +** (a power of two between 512 and 65536) plus some extra bytes for each +** page header. ^The number of extra bytes needed by the page header +** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ]. +** ^It is harmless, apart from the wasted memory, +** for the sz parameter to be larger than necessary. The pMem +** argument must be either a NULL pointer or a pointer to an 8-byte +** aligned block of memory of at least sz*N bytes, otherwise +** subsequent behavior is undefined. +** ^When pMem is not NULL, SQLite will strive to use the memory provided +** to satisfy page cache needs, falling back to [tdsqlite3_malloc()] if +** a page cache line is larger than sz bytes or if all of the pMem buffer +** is exhausted. +** ^If pMem is NULL and N is non-zero, then each database connection +** does an initial bulk allocation for page cache memory +** from [tdsqlite3_malloc()] sufficient for N cache lines if N is positive or +** of -1024*N bytes if N is negative, . ^If additional +** page cache memory is needed beyond what is provided by the initial +** allocation, then SQLite goes to [tdsqlite3_malloc()] separately for each +** additional cache line.
+** +** [[SQLITE_CONFIG_HEAP]]
SQLITE_CONFIG_HEAP
+**
^The SQLITE_CONFIG_HEAP option specifies a static memory buffer +** that SQLite will use for all of its dynamic memory allocation needs +** beyond those provided for by [SQLITE_CONFIG_PAGECACHE]. +** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled +** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns +** [SQLITE_ERROR] if invoked otherwise. +** ^There are three arguments to SQLITE_CONFIG_HEAP: +** An 8-byte aligned pointer to the memory, +** the number of bytes in the memory buffer, and the minimum allocation size. +** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts +** to using its default memory allocator (the system malloc() implementation), +** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the +** memory pointer is not NULL then the alternative memory +** allocator is engaged to handle all of SQLites memory allocation needs. +** The first pointer (the memory pointer) must be aligned to an 8-byte +** boundary or subsequent behavior of SQLite will be undefined. +** The minimum allocation size is capped at 2**12. Reasonable values +** for the minimum allocation size are 2**5 through 2**8.
+** +** [[SQLITE_CONFIG_MUTEX]]
SQLITE_CONFIG_MUTEX
+**
^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a +** pointer to an instance of the [tdsqlite3_mutex_methods] structure. +** The argument specifies alternative low-level mutex routines to be used +** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of +** the content of the [tdsqlite3_mutex_methods] structure before the call to +** [tdsqlite3_config()] returns. ^If SQLite is compiled with +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then +** the entire mutexing subsystem is omitted from the build and hence calls to +** [tdsqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will +** return [SQLITE_ERROR].
+** +** [[SQLITE_CONFIG_GETMUTEX]]
SQLITE_CONFIG_GETMUTEX
+**
^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which +** is a pointer to an instance of the [tdsqlite3_mutex_methods] structure. The +** [tdsqlite3_mutex_methods] +** structure is filled with the currently defined mutex routines.)^ +** This option can be used to overload the default mutex allocation +** routines with a wrapper used to track mutex usage for performance +** profiling or testing, for example. ^If SQLite is compiled with +** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then +** the entire mutexing subsystem is omitted from the build and hence calls to +** [tdsqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will +** return [SQLITE_ERROR].
+** +** [[SQLITE_CONFIG_LOOKASIDE]]
SQLITE_CONFIG_LOOKASIDE
+**
^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine +** the default size of lookaside memory on each [database connection]. +** The first argument is the +** size of each lookaside buffer slot and the second is the number of +** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE +** sets the default lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE] +** option to [tdsqlite3_db_config()] can be used to change the lookaside +** configuration on individual connections.)^
+** +** [[SQLITE_CONFIG_PCACHE2]]
SQLITE_CONFIG_PCACHE2
+**
^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is +** a pointer to an [tdsqlite3_pcache_methods2] object. This object specifies +** the interface to a custom page cache implementation.)^ +** ^SQLite makes a copy of the [tdsqlite3_pcache_methods2] object.
+** +** [[SQLITE_CONFIG_GETPCACHE2]]
SQLITE_CONFIG_GETPCACHE2
+**
^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which +** is a pointer to an [tdsqlite3_pcache_methods2] object. SQLite copies of +** the current page cache implementation into that object.)^
+** +** [[SQLITE_CONFIG_LOG]]
SQLITE_CONFIG_LOG
+**
The SQLITE_CONFIG_LOG option is used to configure the SQLite +** global [error log]. +** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a +** function with a call signature of void(*)(void*,int,const char*), +** and a pointer to void. ^If the function pointer is not NULL, it is +** invoked by [tdsqlite3_log()] to process each logging event. ^If the +** function pointer is NULL, the [tdsqlite3_log()] interface becomes a no-op. +** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is +** passed through as the first parameter to the application-defined logger +** function whenever that function is invoked. ^The second parameter to +** the logger function is a copy of the first parameter to the corresponding +** [tdsqlite3_log()] call and is intended to be a [result code] or an +** [extended result code]. ^The third parameter passed to the logger is +** log message after formatting via [tdsqlite3_snprintf()]. +** The SQLite logging interface is not reentrant; the logger function +** supplied by the application must not invoke any SQLite interface. +** In a multi-threaded application, the application-defined logger +** function must be threadsafe.
+** +** [[SQLITE_CONFIG_URI]]
SQLITE_CONFIG_URI +**
^(The SQLITE_CONFIG_URI option takes a single argument of type int. +** If non-zero, then URI handling is globally enabled. If the parameter is zero, +** then URI handling is globally disabled.)^ ^If URI handling is globally +** enabled, all filenames passed to [tdsqlite3_open()], [tdsqlite3_open_v2()], +** [tdsqlite3_open16()] or +** specified as part of [ATTACH] commands are interpreted as URIs, regardless +** of whether or not the [SQLITE_OPEN_URI] flag is set when the database +** connection is opened. ^If it is globally disabled, filenames are +** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the +** database connection is opened. ^(By default, URI handling is globally +** disabled. The default value may be changed by compiling with the +** [SQLITE_USE_URI] symbol defined.)^ +** +** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]]
SQLITE_CONFIG_COVERING_INDEX_SCAN +**
^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer +** argument which is interpreted as a boolean in order to enable or disable +** the use of covering indices for full table scans in the query optimizer. +** ^The default setting is determined +** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on" +** if that compile-time option is omitted. +** The ability to disable the use of covering indices for full table scans +** is because some incorrectly coded legacy applications might malfunction +** when the optimization is enabled. Providing the ability to +** disable the optimization allows the older, buggy application code to work +** without change even with newer versions of SQLite. +** +** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]] +**
SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE +**
These options are obsolete and should not be used by new code. +** They are retained for backwards compatibility but are now no-ops. +**
+** +** [[SQLITE_CONFIG_SQLLOG]] +**
SQLITE_CONFIG_SQLLOG +**
This option is only available if sqlite is compiled with the +** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should +** be a pointer to a function of type void(*)(void*,tdsqlite3*,const char*, int). +** The second should be of type (void*). The callback is invoked by the library +** in three separate circumstances, identified by the value passed as the +** fourth parameter. If the fourth parameter is 0, then the database connection +** passed as the second argument has just been opened. The third argument +** points to a buffer containing the name of the main database file. If the +** fourth parameter is 1, then the SQL statement that the third parameter +** points to has just been executed. Or, if the fourth parameter is 2, then +** the connection being passed as the second parameter is being closed. The +** third parameter is passed NULL In this case. An example of using this +** configuration option can be seen in the "test_sqllog.c" source file in +** the canonical SQLite source tree.
+** +** [[SQLITE_CONFIG_MMAP_SIZE]] +**
SQLITE_CONFIG_MMAP_SIZE +**
^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (tdsqlite3_int64) values +** that are the default mmap size limit (the default setting for +** [PRAGMA mmap_size]) and the maximum allowed mmap size limit. +** ^The default setting can be overridden by each database connection using +** either the [PRAGMA mmap_size] command, or by using the +** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size +** will be silently truncated if necessary so that it does not exceed the +** compile-time maximum mmap size set by the +** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^ +** ^If either argument to this option is negative, then that argument is +** changed to its compile-time default. +** +** [[SQLITE_CONFIG_WIN32_HEAPSIZE]] +**
SQLITE_CONFIG_WIN32_HEAPSIZE +**
^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is +** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro +** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value +** that specifies the maximum size of the created heap. +** +** [[SQLITE_CONFIG_PCACHE_HDRSZ]] +**
SQLITE_CONFIG_PCACHE_HDRSZ +**
^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which +** is a pointer to an integer and writes into that integer the number of extra +** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE]. +** The amount of extra space required can change depending on the compiler, +** target platform, and SQLite version. +** +** [[SQLITE_CONFIG_PMASZ]] +**
SQLITE_CONFIG_PMASZ +**
^The SQLITE_CONFIG_PMASZ option takes a single parameter which +** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded +** sorter to that integer. The default minimum PMA Size is set by the +** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched +** to help with sort operations when multithreaded sorting +** is enabled (using the [PRAGMA threads] command) and the amount of content +** to be sorted exceeds the page size times the minimum of the +** [PRAGMA cache_size] setting and this value. +** +** [[SQLITE_CONFIG_STMTJRNL_SPILL]] +**
SQLITE_CONFIG_STMTJRNL_SPILL +**
^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which +** becomes the [statement journal] spill-to-disk threshold. +** [Statement journals] are held in memory until their size (in bytes) +** exceeds this threshold, at which point they are written to disk. +** Or if the threshold is -1, statement journals are always held +** exclusively in memory. +** Since many statement journals never become large, setting the spill +** threshold to a value such as 64KiB can greatly reduce the amount of +** I/O required to support statement rollback. +** The default value for this setting is controlled by the +** [SQLITE_STMTJRNL_SPILL] compile-time option. +** +** [[SQLITE_CONFIG_SORTERREF_SIZE]] +**
SQLITE_CONFIG_SORTERREF_SIZE +**
The SQLITE_CONFIG_SORTERREF_SIZE option accepts a single parameter +** of type (int) - the new value of the sorter-reference size threshold. +** Usually, when SQLite uses an external sort to order records according +** to an ORDER BY clause, all fields required by the caller are present in the +** sorted records. However, if SQLite determines based on the declared type +** of a table column that its values are likely to be very large - larger +** than the configured sorter-reference size threshold - then a reference +** is stored in each sorted record and the required column values loaded +** from the database as records are returned in sorted order. The default +** value for this option is to never use this optimization. Specifying a +** negative value for this option restores the default behaviour. +** This option is only available if SQLite is compiled with the +** [SQLITE_ENABLE_SORTER_REFERENCES] compile-time option. +** +** [[SQLITE_CONFIG_MEMDB_MAXSIZE]] +**
SQLITE_CONFIG_MEMDB_MAXSIZE +**
The SQLITE_CONFIG_MEMDB_MAXSIZE option accepts a single parameter +** [tdsqlite3_int64] parameter which is the default maximum size for an in-memory +** database created using [tdsqlite3_deserialize()]. This default maximum +** size can be adjusted up or down for individual databases using the +** [SQLITE_FCNTL_SIZE_LIMIT] [tdsqlite3_file_control|file-control]. If this +** configuration setting is never used, then the default maximum is determined +** by the [SQLITE_MEMDB_DEFAULT_MAXSIZE] compile-time option. If that +** compile-time option is not set, then the default maximum is 1073741824. +**
+*/ +#define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */ +#define SQLITE_CONFIG_MULTITHREAD 2 /* nil */ +#define SQLITE_CONFIG_SERIALIZED 3 /* nil */ +#define SQLITE_CONFIG_MALLOC 4 /* tdsqlite3_mem_methods* */ +#define SQLITE_CONFIG_GETMALLOC 5 /* tdsqlite3_mem_methods* */ +#define SQLITE_CONFIG_SCRATCH 6 /* No longer used */ +#define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */ +#define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */ +#define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */ +#define SQLITE_CONFIG_MUTEX 10 /* tdsqlite3_mutex_methods* */ +#define SQLITE_CONFIG_GETMUTEX 11 /* tdsqlite3_mutex_methods* */ +/* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */ +#define SQLITE_CONFIG_LOOKASIDE 13 /* int int */ +#define SQLITE_CONFIG_PCACHE 14 /* no-op */ +#define SQLITE_CONFIG_GETPCACHE 15 /* no-op */ +#define SQLITE_CONFIG_LOG 16 /* xFunc, void* */ +#define SQLITE_CONFIG_URI 17 /* int */ +#define SQLITE_CONFIG_PCACHE2 18 /* tdsqlite3_pcache_methods2* */ +#define SQLITE_CONFIG_GETPCACHE2 19 /* tdsqlite3_pcache_methods2* */ +#define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */ +#define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */ +#define SQLITE_CONFIG_MMAP_SIZE 22 /* tdsqlite3_int64, tdsqlite3_int64 */ +#define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */ +#define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */ +#define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */ +#define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */ +#define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */ +#define SQLITE_CONFIG_SORTERREF_SIZE 28 /* int nByte */ +#define SQLITE_CONFIG_MEMDB_MAXSIZE 29 /* tdsqlite3_int64 */ + +/* +** CAPI3REF: Database Connection Configuration Options +** +** These constants are the available integer configuration options that +** can be passed as the second argument to the [tdsqlite3_db_config()] interface. +** +** New configuration options may be added in future releases of SQLite. +** Existing configuration options might be discontinued. Applications +** should check the return code from [tdsqlite3_db_config()] to make sure that +** the call worked. ^The [tdsqlite3_db_config()] interface will return a +** non-zero [error code] if a discontinued or unsupported configuration option +** is invoked. +** +**
+** [[SQLITE_DBCONFIG_LOOKASIDE]] +**
SQLITE_DBCONFIG_LOOKASIDE
+**
^This option takes three additional arguments that determine the +** [lookaside memory allocator] configuration for the [database connection]. +** ^The first argument (the third parameter to [tdsqlite3_db_config()] is a +** pointer to a memory buffer to use for lookaside memory. +** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb +** may be NULL in which case SQLite will allocate the +** lookaside buffer itself using [tdsqlite3_malloc()]. ^The second argument is the +** size of each lookaside buffer slot. ^The third argument is the number of +** slots. The size of the buffer in the first argument must be greater than +** or equal to the product of the second and third arguments. The buffer +** must be aligned to an 8-byte boundary. ^If the second argument to +** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally +** rounded down to the next smaller multiple of 8. ^(The lookaside memory +** configuration for a database connection can only be changed when that +** connection is not currently using lookaside memory, or in other words +** when the "current value" returned by +** [tdsqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero. +** Any attempt to change the lookaside memory configuration when lookaside +** memory is in use leaves the configuration unchanged and returns +** [SQLITE_BUSY].)^
+** +** [[SQLITE_DBCONFIG_ENABLE_FKEY]] +**
SQLITE_DBCONFIG_ENABLE_FKEY
+**
^This option is used to enable or disable the enforcement of +** [foreign key constraints]. There should be two additional arguments. +** The first argument is an integer which is 0 to disable FK enforcement, +** positive to enable FK enforcement or negative to leave FK enforcement +** unchanged. The second parameter is a pointer to an integer into which +** is written 0 or 1 to indicate whether FK enforcement is off or on +** following this call. The second parameter may be a NULL pointer, in +** which case the FK enforcement setting is not reported back.
+** +** [[SQLITE_DBCONFIG_ENABLE_TRIGGER]] +**
SQLITE_DBCONFIG_ENABLE_TRIGGER
+**
^This option is used to enable or disable [CREATE TRIGGER | triggers]. +** There should be two additional arguments. +** The first argument is an integer which is 0 to disable triggers, +** positive to enable triggers or negative to leave the setting unchanged. +** The second parameter is a pointer to an integer into which +** is written 0 or 1 to indicate whether triggers are disabled or enabled +** following this call. The second parameter may be a NULL pointer, in +** which case the trigger setting is not reported back.
+** +** [[SQLITE_DBCONFIG_ENABLE_VIEW]] +**
SQLITE_DBCONFIG_ENABLE_VIEW
+**
^This option is used to enable or disable [CREATE VIEW | views]. +** There should be two additional arguments. +** The first argument is an integer which is 0 to disable views, +** positive to enable views or negative to leave the setting unchanged. +** The second parameter is a pointer to an integer into which +** is written 0 or 1 to indicate whether views are disabled or enabled +** following this call. The second parameter may be a NULL pointer, in +** which case the view setting is not reported back.
+** +** [[SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER]] +**
SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER
+**
^This option is used to enable or disable the +** [fts3_tokenizer()] function which is part of the +** [FTS3] full-text search engine extension. +** There should be two additional arguments. +** The first argument is an integer which is 0 to disable fts3_tokenizer() or +** positive to enable fts3_tokenizer() or negative to leave the setting +** unchanged. +** The second parameter is a pointer to an integer into which +** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled +** following this call. The second parameter may be a NULL pointer, in +** which case the new setting is not reported back.
+** +** [[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION]] +**
SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION
+**
^This option is used to enable or disable the [tdsqlite3_load_extension()] +** interface independently of the [load_extension()] SQL function. +** The [tdsqlite3_enable_load_extension()] API enables or disables both the +** C-API [tdsqlite3_load_extension()] and the SQL function [load_extension()]. +** There should be two additional arguments. +** When the first argument to this interface is 1, then only the C-API is +** enabled and the SQL function remains disabled. If the first argument to +** this interface is 0, then both the C-API and the SQL function are disabled. +** If the first argument is -1, then no changes are made to state of either the +** C-API or the SQL function. +** The second parameter is a pointer to an integer into which +** is written 0 or 1 to indicate whether [tdsqlite3_load_extension()] interface +** is disabled or enabled following this call. The second parameter may +** be a NULL pointer, in which case the new setting is not reported back. +**
+** +** [[SQLITE_DBCONFIG_MAINDBNAME]]
SQLITE_DBCONFIG_MAINDBNAME
+**
^This option is used to change the name of the "main" database +** schema. ^The sole argument is a pointer to a constant UTF8 string +** which will become the new schema name in place of "main". ^SQLite +** does not make a copy of the new main schema name string, so the application +** must ensure that the argument passed into this DBCONFIG option is unchanged +** until after the database connection closes. +**
+** +** [[SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE]] +**
SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE
+**
Usually, when a database in wal mode is closed or detached from a +** database handle, SQLite checks if this will mean that there are now no +** connections at all to the database. If so, it performs a checkpoint +** operation before closing the connection. This option may be used to +** override this behaviour. The first parameter passed to this operation +** is an integer - positive to disable checkpoints-on-close, or zero (the +** default) to enable them, and negative to leave the setting unchanged. +** The second parameter is a pointer to an integer +** into which is written 0 or 1 to indicate whether checkpoints-on-close +** have been disabled - 0 if they are not disabled, 1 if they are. +**
+** +** [[SQLITE_DBCONFIG_ENABLE_QPSG]]
SQLITE_DBCONFIG_ENABLE_QPSG
+**
^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates +** the [query planner stability guarantee] (QPSG). When the QPSG is active, +** a single SQL query statement will always use the same algorithm regardless +** of values of [bound parameters].)^ The QPSG disables some query optimizations +** that look at the values of bound parameters, which can make some queries +** slower. But the QPSG has the advantage of more predictable behavior. With +** the QPSG active, SQLite will always use the same query plan in the field as +** was used during testing in the lab. +** The first argument to this setting is an integer which is 0 to disable +** the QPSG, positive to enable QPSG, or negative to leave the setting +** unchanged. The second parameter is a pointer to an integer into which +** is written 0 or 1 to indicate whether the QPSG is disabled or enabled +** following this call. +**
+** +** [[SQLITE_DBCONFIG_TRIGGER_EQP]]
SQLITE_DBCONFIG_TRIGGER_EQP
+**
By default, the output of EXPLAIN QUERY PLAN commands does not +** include output for any operations performed by trigger programs. This +** option is used to set or clear (the default) a flag that governs this +** behavior. The first parameter passed to this operation is an integer - +** positive to enable output for trigger programs, or zero to disable it, +** or negative to leave the setting unchanged. +** The second parameter is a pointer to an integer into which is written +** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if +** it is not disabled, 1 if it is. +**
+** +** [[SQLITE_DBCONFIG_RESET_DATABASE]]
SQLITE_DBCONFIG_RESET_DATABASE
+**
Set the SQLITE_DBCONFIG_RESET_DATABASE flag and then run +** [VACUUM] in order to reset a database back to an empty database +** with no schema and no content. The following process works even for +** a badly corrupted database file: +**
    +**
  1. If the database connection is newly opened, make sure it has read the +** database schema by preparing then discarding some query against the +** database, or calling tdsqlite3_table_column_metadata(), ignoring any +** errors. This step is only necessary if the application desires to keep +** the database in WAL mode after the reset if it was in WAL mode before +** the reset. +**
  2. tdsqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 1, 0); +**
  3. [tdsqlite3_exec](db, "[VACUUM]", 0, 0, 0); +**
  4. tdsqlite3_db_config(db, SQLITE_DBCONFIG_RESET_DATABASE, 0, 0); +**
+** Because resetting a database is destructive and irreversible, the +** process requires the use of this obscure API and multiple steps to help +** ensure that it does not happen by accident. +** +** [[SQLITE_DBCONFIG_DEFENSIVE]]
SQLITE_DBCONFIG_DEFENSIVE
+**
The SQLITE_DBCONFIG_DEFENSIVE option activates or deactivates the +** "defensive" flag for a database connection. When the defensive +** flag is enabled, language features that allow ordinary SQL to +** deliberately corrupt the database file are disabled. The disabled +** features include but are not limited to the following: +**
    +**
  • The [PRAGMA writable_schema=ON] statement. +**
  • The [PRAGMA journal_mode=OFF] statement. +**
  • Writes to the [sqlite_dbpage] virtual table. +**
  • Direct writes to [shadow tables]. +**
+**
+** +** [[SQLITE_DBCONFIG_WRITABLE_SCHEMA]]
SQLITE_DBCONFIG_WRITABLE_SCHEMA
+**
The SQLITE_DBCONFIG_WRITABLE_SCHEMA option activates or deactivates the +** "writable_schema" flag. This has the same effect and is logically equivalent +** to setting [PRAGMA writable_schema=ON] or [PRAGMA writable_schema=OFF]. +** The first argument to this setting is an integer which is 0 to disable +** the writable_schema, positive to enable writable_schema, or negative to +** leave the setting unchanged. The second parameter is a pointer to an +** integer into which is written 0 or 1 to indicate whether the writable_schema +** is enabled or disabled following this call. +**
+** +** [[SQLITE_DBCONFIG_LEGACY_ALTER_TABLE]] +**
SQLITE_DBCONFIG_LEGACY_ALTER_TABLE
+**
The SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option activates or deactivates +** the legacy behavior of the [ALTER TABLE RENAME] command such it +** behaves as it did prior to [version 3.24.0] (2018-06-04). See the +** "Compatibility Notice" on the [ALTER TABLE RENAME documentation] for +** additional information. This feature can also be turned on and off +** using the [PRAGMA legacy_alter_table] statement. +**
+** +** [[SQLITE_DBCONFIG_DQS_DML]] +**
SQLITE_DBCONFIG_DQS_DML +**
The SQLITE_DBCONFIG_DQS_DML option activates or deactivates +** the legacy [double-quoted string literal] misfeature for DML statements +** only, that is DELETE, INSERT, SELECT, and UPDATE statements. The +** default value of this setting is determined by the [-DSQLITE_DQS] +** compile-time option. +**
+** +** [[SQLITE_DBCONFIG_DQS_DDL]] +**
SQLITE_DBCONFIG_DQS_DDL +**
The SQLITE_DBCONFIG_DQS option activates or deactivates +** the legacy [double-quoted string literal] misfeature for DDL statements, +** such as CREATE TABLE and CREATE INDEX. The +** default value of this setting is determined by the [-DSQLITE_DQS] +** compile-time option. +**
+** +** [[SQLITE_DBCONFIG_TRUSTED_SCHEMA]] +**
SQLITE_DBCONFIG_TRUSTED_SCHEMA +**
The SQLITE_DBCONFIG_TRUSTED_SCHEMA option tells SQLite to +** assume that database schemas (the contents of the [sqlite_master] tables) +** are untainted by malicious content. +** When the SQLITE_DBCONFIG_TRUSTED_SCHEMA option is disabled, SQLite +** takes additional defensive steps to protect the application from harm +** including: +**
    +**
  • Prohibit the use of SQL functions inside triggers, views, +** CHECK constraints, DEFAULT clauses, expression indexes, +** partial indexes, or generated columns +** unless those functions are tagged with [SQLITE_INNOCUOUS]. +**
  • Prohibit the use of virtual tables inside of triggers or views +** unless those virtual tables are tagged with [SQLITE_VTAB_INNOCUOUS]. +**
+** This setting defaults to "on" for legacy compatibility, however +** all applications are advised to turn it off if possible. This setting +** can also be controlled using the [PRAGMA trusted_schema] statement. +**
+** +** [[SQLITE_DBCONFIG_LEGACY_FILE_FORMAT]] +**
SQLITE_DBCONFIG_LEGACY_FILE_FORMAT +**
The SQLITE_DBCONFIG_LEGACY_FILE_FORMAT option activates or deactivates +** the legacy file format flag. When activated, this flag causes all newly +** created database file to have a schema format version number (the 4-byte +** integer found at offset 44 into the database header) of 1. This in turn +** means that the resulting database file will be readable and writable by +** any SQLite version back to 3.0.0 ([dateof:3.0.0]). Without this setting, +** newly created databases are generally not understandable by SQLite versions +** prior to 3.3.0 ([dateof:3.3.0]). As these words are written, there +** is now scarcely any need to generated database files that are compatible +** all the way back to version 3.0.0, and so this setting is of little +** practical use, but is provided so that SQLite can continue to claim the +** ability to generate new database files that are compatible with version +** 3.0.0. +**

Note that when the SQLITE_DBCONFIG_LEGACY_FILE_FORMAT setting is on, +** the [VACUUM] command will fail with an obscure error when attempting to +** process a table with generated columns and a descending index. This is +** not considered a bug since SQLite versions 3.3.0 and earlier do not support +** either generated columns or decending indexes. +**

+**
+*/ +#define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */ +#define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */ +#define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */ +#define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */ +#define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */ +#define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */ +#define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */ +#define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */ +#define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */ +#define SQLITE_DBCONFIG_RESET_DATABASE 1009 /* int int* */ +#define SQLITE_DBCONFIG_DEFENSIVE 1010 /* int int* */ +#define SQLITE_DBCONFIG_WRITABLE_SCHEMA 1011 /* int int* */ +#define SQLITE_DBCONFIG_LEGACY_ALTER_TABLE 1012 /* int int* */ +#define SQLITE_DBCONFIG_DQS_DML 1013 /* int int* */ +#define SQLITE_DBCONFIG_DQS_DDL 1014 /* int int* */ +#define SQLITE_DBCONFIG_ENABLE_VIEW 1015 /* int int* */ +#define SQLITE_DBCONFIG_LEGACY_FILE_FORMAT 1016 /* int int* */ +#define SQLITE_DBCONFIG_TRUSTED_SCHEMA 1017 /* int int* */ +#define SQLITE_DBCONFIG_MAX 1017 /* Largest DBCONFIG */ + +/* +** CAPI3REF: Enable Or Disable Extended Result Codes +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_extended_result_codes() routine enables or disables the +** [extended result codes] feature of SQLite. ^The extended result +** codes are disabled by default for historical compatibility. +*/ +SQLITE_API int tdsqlite3_extended_result_codes(tdsqlite3*, int onoff); + +/* +** CAPI3REF: Last Insert Rowid +** METHOD: tdsqlite3 +** +** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables) +** has a unique 64-bit signed +** integer key called the [ROWID | "rowid"]. ^The rowid is always available +** as an undeclared column named ROWID, OID, or _ROWID_ as long as those +** names are not also used by explicitly declared columns. ^If +** the table has a column of type [INTEGER PRIMARY KEY] then that column +** is another alias for the rowid. +** +** ^The tdsqlite3_last_insert_rowid(D) interface usually returns the [rowid] of +** the most recent successful [INSERT] into a rowid table or [virtual table] +** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not +** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred +** on the database connection D, then tdsqlite3_last_insert_rowid(D) returns +** zero. +** +** As well as being set automatically as rows are inserted into database +** tables, the value returned by this function may be set explicitly by +** [tdsqlite3_set_last_insert_rowid()] +** +** Some virtual table implementations may INSERT rows into rowid tables as +** part of committing a transaction (e.g. to flush data accumulated in memory +** to disk). In this case subsequent calls to this function return the rowid +** associated with these internal INSERT operations, which leads to +** unintuitive results. Virtual table implementations that do write to rowid +** tables in this way can avoid this problem by restoring the original +** rowid value using [tdsqlite3_set_last_insert_rowid()] before returning +** control to the user. +** +** ^(If an [INSERT] occurs within a trigger then this routine will +** return the [rowid] of the inserted row as long as the trigger is +** running. Once the trigger program ends, the value returned +** by this routine reverts to what it was before the trigger was fired.)^ +** +** ^An [INSERT] that fails due to a constraint violation is not a +** successful [INSERT] and does not change the value returned by this +** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK, +** and INSERT OR ABORT make no changes to the return value of this +** routine when their insertion fails. ^(When INSERT OR REPLACE +** encounters a constraint violation, it does not fail. The +** INSERT continues to completion after deleting rows that caused +** the constraint problem so INSERT OR REPLACE will always change +** the return value of this interface.)^ +** +** ^For the purposes of this routine, an [INSERT] is considered to +** be successful even if it is subsequently rolled back. +** +** This function is accessible to SQL statements via the +** [last_insert_rowid() SQL function]. +** +** If a separate thread performs a new [INSERT] on the same +** database connection while the [tdsqlite3_last_insert_rowid()] +** function is running and thus changes the last insert [rowid], +** then the value returned by [tdsqlite3_last_insert_rowid()] is +** unpredictable and might not equal either the old or the new +** last insert [rowid]. +*/ +SQLITE_API tdsqlite3_int64 tdsqlite3_last_insert_rowid(tdsqlite3*); + +/* +** CAPI3REF: Set the Last Insert Rowid value. +** METHOD: tdsqlite3 +** +** The tdsqlite3_set_last_insert_rowid(D, R) method allows the application to +** set the value returned by calling tdsqlite3_last_insert_rowid(D) to R +** without inserting a row into the database. +*/ +SQLITE_API void tdsqlite3_set_last_insert_rowid(tdsqlite3*,tdsqlite3_int64); + +/* +** CAPI3REF: Count The Number Of Rows Modified +** METHOD: tdsqlite3 +** +** ^This function returns the number of rows modified, inserted or +** deleted by the most recently completed INSERT, UPDATE or DELETE +** statement on the database connection specified by the only parameter. +** ^Executing any other type of SQL statement does not modify the value +** returned by this function. +** +** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are +** considered - auxiliary changes caused by [CREATE TRIGGER | triggers], +** [foreign key actions] or [REPLACE] constraint resolution are not counted. +** +** Changes to a view that are intercepted by +** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value +** returned by tdsqlite3_changes() immediately after an INSERT, UPDATE or +** DELETE statement run on a view is always zero. Only changes made to real +** tables are counted. +** +** Things are more complicated if the tdsqlite3_changes() function is +** executed while a trigger program is running. This may happen if the +** program uses the [changes() SQL function], or if some other callback +** function invokes tdsqlite3_changes() directly. Essentially: +** +**
    +**
  • ^(Before entering a trigger program the value returned by +** tdsqlite3_changes() function is saved. After the trigger program +** has finished, the original value is restored.)^ +** +**
  • ^(Within a trigger program each INSERT, UPDATE and DELETE +** statement sets the value returned by tdsqlite3_changes() +** upon completion as normal. Of course, this value will not include +** any changes performed by sub-triggers, as the tdsqlite3_changes() +** value will be saved and restored after each sub-trigger has run.)^ +**
+** +** ^This means that if the changes() SQL function (or similar) is used +** by the first INSERT, UPDATE or DELETE statement within a trigger, it +** returns the value as set when the calling statement began executing. +** ^If it is used by the second or subsequent such statement within a trigger +** program, the value returned reflects the number of rows modified by the +** previous INSERT, UPDATE or DELETE statement within the same trigger. +** +** If a separate thread makes changes on the same database connection +** while [tdsqlite3_changes()] is running then the value returned +** is unpredictable and not meaningful. +** +** See also: +**
    +**
  • the [tdsqlite3_total_changes()] interface +**
  • the [count_changes pragma] +**
  • the [changes() SQL function] +**
  • the [data_version pragma] +**
+*/ +SQLITE_API int tdsqlite3_changes(tdsqlite3*); + +/* +** CAPI3REF: Total Number Of Rows Modified +** METHOD: tdsqlite3 +** +** ^This function returns the total number of rows inserted, modified or +** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed +** since the database connection was opened, including those executed as +** part of trigger programs. ^Executing any other type of SQL statement +** does not affect the value returned by tdsqlite3_total_changes(). +** +** ^Changes made as part of [foreign key actions] are included in the +** count, but those made as part of REPLACE constraint resolution are +** not. ^Changes to a view that are intercepted by INSTEAD OF triggers +** are not counted. +** +** The [tdsqlite3_total_changes(D)] interface only reports the number +** of rows that changed due to SQL statement run against database +** connection D. Any changes by other database connections are ignored. +** To detect changes against a database file from other database +** connections use the [PRAGMA data_version] command or the +** [SQLITE_FCNTL_DATA_VERSION] [file control]. +** +** If a separate thread makes changes on the same database connection +** while [tdsqlite3_total_changes()] is running then the value +** returned is unpredictable and not meaningful. +** +** See also: +**
    +**
  • the [tdsqlite3_changes()] interface +**
  • the [count_changes pragma] +**
  • the [changes() SQL function] +**
  • the [data_version pragma] +**
  • the [SQLITE_FCNTL_DATA_VERSION] [file control] +**
+*/ +SQLITE_API int tdsqlite3_total_changes(tdsqlite3*); + +/* +** CAPI3REF: Interrupt A Long-Running Query +** METHOD: tdsqlite3 +** +** ^This function causes any pending database operation to abort and +** return at its earliest opportunity. This routine is typically +** called in response to a user action such as pressing "Cancel" +** or Ctrl-C where the user wants a long query operation to halt +** immediately. +** +** ^It is safe to call this routine from a thread different from the +** thread that is currently running the database operation. But it +** is not safe to call this routine with a [database connection] that +** is closed or might close before tdsqlite3_interrupt() returns. +** +** ^If an SQL operation is very nearly finished at the time when +** tdsqlite3_interrupt() is called, then it might not have an opportunity +** to be interrupted and might continue to completion. +** +** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT]. +** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE +** that is inside an explicit transaction, then the entire transaction +** will be rolled back automatically. +** +** ^The tdsqlite3_interrupt(D) call is in effect until all currently running +** SQL statements on [database connection] D complete. ^Any new SQL statements +** that are started after the tdsqlite3_interrupt() call and before the +** running statement count reaches zero are interrupted as if they had been +** running prior to the tdsqlite3_interrupt() call. ^New SQL statements +** that are started after the running statement count reaches zero are +** not effected by the tdsqlite3_interrupt(). +** ^A call to tdsqlite3_interrupt(D) that occurs when there are no running +** SQL statements is a no-op and has no effect on SQL statements +** that are started after the tdsqlite3_interrupt() call returns. +*/ +SQLITE_API void tdsqlite3_interrupt(tdsqlite3*); + +/* +** CAPI3REF: Determine If An SQL Statement Is Complete +** +** These routines are useful during command-line input to determine if the +** currently entered text seems to form a complete SQL statement or +** if additional input is needed before sending the text into +** SQLite for parsing. ^These routines return 1 if the input string +** appears to be a complete SQL statement. ^A statement is judged to be +** complete if it ends with a semicolon token and is not a prefix of a +** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within +** string literals or quoted identifier names or comments are not +** independent tokens (they are part of the token in which they are +** embedded) and thus do not count as a statement terminator. ^Whitespace +** and comments that follow the final semicolon are ignored. +** +** ^These routines return 0 if the statement is incomplete. ^If a +** memory allocation fails, then SQLITE_NOMEM is returned. +** +** ^These routines do not parse the SQL statements thus +** will not detect syntactically incorrect SQL. +** +** ^(If SQLite has not been initialized using [tdsqlite3_initialize()] prior +** to invoking tdsqlite3_complete16() then tdsqlite3_initialize() is invoked +** automatically by tdsqlite3_complete16(). If that initialization fails, +** then the return value from tdsqlite3_complete16() will be non-zero +** regardless of whether or not the input SQL is complete.)^ +** +** The input to [tdsqlite3_complete()] must be a zero-terminated +** UTF-8 string. +** +** The input to [tdsqlite3_complete16()] must be a zero-terminated +** UTF-16 string in native byte order. +*/ +SQLITE_API int tdsqlite3_complete(const char *sql); +SQLITE_API int tdsqlite3_complete16(const void *sql); + +/* +** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors +** KEYWORDS: {busy-handler callback} {busy handler} +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_busy_handler(D,X,P) routine sets a callback function X +** that might be invoked with argument P whenever +** an attempt is made to access a database table associated with +** [database connection] D when another thread +** or process has the table locked. +** The tdsqlite3_busy_handler() interface is used to implement +** [tdsqlite3_busy_timeout()] and [PRAGMA busy_timeout]. +** +** ^If the busy callback is NULL, then [SQLITE_BUSY] +** is returned immediately upon encountering the lock. ^If the busy callback +** is not NULL, then the callback might be invoked with two arguments. +** +** ^The first argument to the busy handler is a copy of the void* pointer which +** is the third argument to tdsqlite3_busy_handler(). ^The second argument to +** the busy handler callback is the number of times that the busy handler has +** been invoked previously for the same locking event. ^If the +** busy callback returns 0, then no additional attempts are made to +** access the database and [SQLITE_BUSY] is returned +** to the application. +** ^If the callback returns non-zero, then another attempt +** is made to access the database and the cycle repeats. +** +** The presence of a busy handler does not guarantee that it will be invoked +** when there is lock contention. ^If SQLite determines that invoking the busy +** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY] +** to the application instead of invoking the +** busy handler. +** Consider a scenario where one process is holding a read lock that +** it is trying to promote to a reserved lock and +** a second process is holding a reserved lock that it is trying +** to promote to an exclusive lock. The first process cannot proceed +** because it is blocked by the second and the second process cannot +** proceed because it is blocked by the first. If both processes +** invoke the busy handlers, neither will make any progress. Therefore, +** SQLite returns [SQLITE_BUSY] for the first process, hoping that this +** will induce the first process to release its read lock and allow +** the second process to proceed. +** +** ^The default busy callback is NULL. +** +** ^(There can only be a single busy handler defined for each +** [database connection]. Setting a new busy handler clears any +** previously set handler.)^ ^Note that calling [tdsqlite3_busy_timeout()] +** or evaluating [PRAGMA busy_timeout=N] will change the +** busy handler and thus clear any previously set busy handler. +** +** The busy callback should not take any actions which modify the +** database connection that invoked the busy handler. In other words, +** the busy handler is not reentrant. Any such actions +** result in undefined behavior. +** +** A busy handler must not close the database connection +** or [prepared statement] that invoked the busy handler. +*/ +SQLITE_API int tdsqlite3_busy_handler(tdsqlite3*,int(*)(void*,int),void*); + +/* +** CAPI3REF: Set A Busy Timeout +** METHOD: tdsqlite3 +** +** ^This routine sets a [tdsqlite3_busy_handler | busy handler] that sleeps +** for a specified amount of time when a table is locked. ^The handler +** will sleep multiple times until at least "ms" milliseconds of sleeping +** have accumulated. ^After at least "ms" milliseconds of sleeping, +** the handler returns 0 which causes [tdsqlite3_step()] to return +** [SQLITE_BUSY]. +** +** ^Calling this routine with an argument less than or equal to zero +** turns off all busy handlers. +** +** ^(There can only be a single busy handler for a particular +** [database connection] at any given moment. If another busy handler +** was defined (using [tdsqlite3_busy_handler()]) prior to calling +** this routine, that other busy handler is cleared.)^ +** +** See also: [PRAGMA busy_timeout] +*/ +SQLITE_API int tdsqlite3_busy_timeout(tdsqlite3*, int ms); + +/* +** CAPI3REF: Convenience Routines For Running Queries +** METHOD: tdsqlite3 +** +** This is a legacy interface that is preserved for backwards compatibility. +** Use of this interface is not recommended. +** +** Definition: A result table is memory data structure created by the +** [tdsqlite3_get_table()] interface. A result table records the +** complete query results from one or more queries. +** +** The table conceptually has a number of rows and columns. But +** these numbers are not part of the result table itself. These +** numbers are obtained separately. Let N be the number of rows +** and M be the number of columns. +** +** A result table is an array of pointers to zero-terminated UTF-8 strings. +** There are (N+1)*M elements in the array. The first M pointers point +** to zero-terminated strings that contain the names of the columns. +** The remaining entries all point to query results. NULL values result +** in NULL pointers. All other values are in their UTF-8 zero-terminated +** string representation as returned by [tdsqlite3_column_text()]. +** +** A result table might consist of one or more memory allocations. +** It is not safe to pass a result table directly to [tdsqlite3_free()]. +** A result table should be deallocated using [tdsqlite3_free_table()]. +** +** ^(As an example of the result table format, suppose a query result +** is as follows: +** +** 
+**        Name        | Age
+**        -----------------------
+**        Alice       | 43
+**        Bob         | 28
+**        Cindy       | 21
+**
+** +** There are two columns (M==2) and three rows (N==3). Thus the +** result table has 8 entries. Suppose the result table is stored +** in an array named azResult. Then azResult holds this content: +** +** 
+**        azResult[0] = "Name";
+**        azResult[1] = "Age";
+**        azResult[2] = "Alice";
+**        azResult[3] = "43";
+**        azResult[4] = "Bob";
+**        azResult[5] = "28";
+**        azResult[6] = "Cindy";
+**        azResult[7] = "21";
+**
)^ +** +** ^The tdsqlite3_get_table() function evaluates one or more +** semicolon-separated SQL statements in the zero-terminated UTF-8 +** string of its 2nd parameter and returns a result table to the +** pointer given in its 3rd parameter. +** +** After the application has finished with the result from tdsqlite3_get_table(), +** it must pass the result table pointer to tdsqlite3_free_table() in order to +** release the memory that was malloced. Because of the way the +** [tdsqlite3_malloc()] happens within tdsqlite3_get_table(), the calling +** function must not try to call [tdsqlite3_free()] directly. Only +** [tdsqlite3_free_table()] is able to release the memory properly and safely. +** +** The tdsqlite3_get_table() interface is implemented as a wrapper around +** [tdsqlite3_exec()]. The tdsqlite3_get_table() routine does not have access +** to any internal data structures of SQLite. It uses only the public +** interface defined here. As a consequence, errors that occur in the +** wrapper layer outside of the internal [tdsqlite3_exec()] call are not +** reflected in subsequent calls to [tdsqlite3_errcode()] or +** [tdsqlite3_errmsg()]. +*/ +SQLITE_API int tdsqlite3_get_table( + tdsqlite3 *db, /* An open database */ + const char *zSql, /* SQL to be evaluated */ + char ***pazResult, /* Results of the query */ + int *pnRow, /* Number of result rows written here */ + int *pnColumn, /* Number of result columns written here */ + char **pzErrmsg /* Error msg written here */ +); +SQLITE_API void tdsqlite3_free_table(char **result); + +/* +** CAPI3REF: Formatted String Printing Functions +** +** These routines are work-alikes of the "printf()" family of functions +** from the standard C library. +** These routines understand most of the common formatting options from +** the standard library printf() +** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]). +** See the [built-in printf()] documentation for details. +** +** ^The tdsqlite3_mprintf() and tdsqlite3_vmprintf() routines write their +** results into memory obtained from [tdsqlite3_malloc64()]. +** The strings returned by these two routines should be +** released by [tdsqlite3_free()]. ^Both routines return a +** NULL pointer if [tdsqlite3_malloc64()] is unable to allocate enough +** memory to hold the resulting string. +** +** ^(The tdsqlite3_snprintf() routine is similar to "snprintf()" from +** the standard C library. The result is written into the +** buffer supplied as the second parameter whose size is given by +** the first parameter. Note that the order of the +** first two parameters is reversed from snprintf().)^ This is an +** historical accident that cannot be fixed without breaking +** backwards compatibility. ^(Note also that tdsqlite3_snprintf() +** returns a pointer to its buffer instead of the number of +** characters actually written into the buffer.)^ We admit that +** the number of characters written would be a more useful return +** value but we cannot change the implementation of tdsqlite3_snprintf() +** now without breaking compatibility. +** +** ^As long as the buffer size is greater than zero, tdsqlite3_snprintf() +** guarantees that the buffer is always zero-terminated. ^The first +** parameter "n" is the total size of the buffer, including space for +** the zero terminator. So the longest string that can be completely +** written will be n-1 characters. +** +** ^The tdsqlite3_vsnprintf() routine is a varargs version of tdsqlite3_snprintf(). +** +** See also: [built-in printf()], [printf() SQL function] +*/ +SQLITE_API char *tdsqlite3_mprintf(const char*,...); +SQLITE_API char *tdsqlite3_vmprintf(const char*, va_list); +SQLITE_API char *tdsqlite3_snprintf(int,char*,const char*, ...); +SQLITE_API char *tdsqlite3_vsnprintf(int,char*,const char*, va_list); + +/* +** CAPI3REF: Memory Allocation Subsystem +** +** The SQLite core uses these three routines for all of its own +** internal memory allocation needs. "Core" in the previous sentence +** does not include operating-system specific [VFS] implementation. The +** Windows VFS uses native malloc() and free() for some operations. +** +** ^The tdsqlite3_malloc() routine returns a pointer to a block +** of memory at least N bytes in length, where N is the parameter. +** ^If tdsqlite3_malloc() is unable to obtain sufficient free +** memory, it returns a NULL pointer. ^If the parameter N to +** tdsqlite3_malloc() is zero or negative then tdsqlite3_malloc() returns +** a NULL pointer. +** +** ^The tdsqlite3_malloc64(N) routine works just like +** tdsqlite3_malloc(N) except that N is an unsigned 64-bit integer instead +** of a signed 32-bit integer. +** +** ^Calling tdsqlite3_free() with a pointer previously returned +** by tdsqlite3_malloc() or tdsqlite3_realloc() releases that memory so +** that it might be reused. ^The tdsqlite3_free() routine is +** a no-op if is called with a NULL pointer. Passing a NULL pointer +** to tdsqlite3_free() is harmless. After being freed, memory +** should neither be read nor written. Even reading previously freed +** memory might result in a segmentation fault or other severe error. +** Memory corruption, a segmentation fault, or other severe error +** might result if tdsqlite3_free() is called with a non-NULL pointer that +** was not obtained from tdsqlite3_malloc() or tdsqlite3_realloc(). +** +** ^The tdsqlite3_realloc(X,N) interface attempts to resize a +** prior memory allocation X to be at least N bytes. +** ^If the X parameter to tdsqlite3_realloc(X,N) +** is a NULL pointer then its behavior is identical to calling +** tdsqlite3_malloc(N). +** ^If the N parameter to tdsqlite3_realloc(X,N) is zero or +** negative then the behavior is exactly the same as calling +** tdsqlite3_free(X). +** ^tdsqlite3_realloc(X,N) returns a pointer to a memory allocation +** of at least N bytes in size or NULL if insufficient memory is available. +** ^If M is the size of the prior allocation, then min(N,M) bytes +** of the prior allocation are copied into the beginning of buffer returned +** by tdsqlite3_realloc(X,N) and the prior allocation is freed. +** ^If tdsqlite3_realloc(X,N) returns NULL and N is positive, then the +** prior allocation is not freed. +** +** ^The tdsqlite3_realloc64(X,N) interfaces works the same as +** tdsqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead +** of a 32-bit signed integer. +** +** ^If X is a memory allocation previously obtained from tdsqlite3_malloc(), +** tdsqlite3_malloc64(), tdsqlite3_realloc(), or tdsqlite3_realloc64(), then +** tdsqlite3_msize(X) returns the size of that memory allocation in bytes. +** ^The value returned by tdsqlite3_msize(X) might be larger than the number +** of bytes requested when X was allocated. ^If X is a NULL pointer then +** tdsqlite3_msize(X) returns zero. If X points to something that is not +** the beginning of memory allocation, or if it points to a formerly +** valid memory allocation that has now been freed, then the behavior +** of tdsqlite3_msize(X) is undefined and possibly harmful. +** +** ^The memory returned by tdsqlite3_malloc(), tdsqlite3_realloc(), +** tdsqlite3_malloc64(), and tdsqlite3_realloc64() +** is always aligned to at least an 8 byte boundary, or to a +** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time +** option is used. +** +** The pointer arguments to [tdsqlite3_free()] and [tdsqlite3_realloc()] +** must be either NULL or else pointers obtained from a prior +** invocation of [tdsqlite3_malloc()] or [tdsqlite3_realloc()] that have +** not yet been released. +** +** The application must not read or write any part of +** a block of memory after it has been released using +** [tdsqlite3_free()] or [tdsqlite3_realloc()]. +*/ +SQLITE_API void *tdsqlite3_malloc(int); +SQLITE_API void *tdsqlite3_malloc64(tdsqlite3_uint64); +SQLITE_API void *tdsqlite3_realloc(void*, int); +SQLITE_API void *tdsqlite3_realloc64(void*, tdsqlite3_uint64); +SQLITE_API void tdsqlite3_free(void*); +SQLITE_API tdsqlite3_uint64 tdsqlite3_msize(void*); + +/* +** CAPI3REF: Memory Allocator Statistics +** +** SQLite provides these two interfaces for reporting on the status +** of the [tdsqlite3_malloc()], [tdsqlite3_free()], and [tdsqlite3_realloc()] +** routines, which form the built-in memory allocation subsystem. +** +** ^The [tdsqlite3_memory_used()] routine returns the number of bytes +** of memory currently outstanding (malloced but not freed). +** ^The [tdsqlite3_memory_highwater()] routine returns the maximum +** value of [tdsqlite3_memory_used()] since the high-water mark +** was last reset. ^The values returned by [tdsqlite3_memory_used()] and +** [tdsqlite3_memory_highwater()] include any overhead +** added by SQLite in its implementation of [tdsqlite3_malloc()], +** but not overhead added by the any underlying system library +** routines that [tdsqlite3_malloc()] may call. +** +** ^The memory high-water mark is reset to the current value of +** [tdsqlite3_memory_used()] if and only if the parameter to +** [tdsqlite3_memory_highwater()] is true. ^The value returned +** by [tdsqlite3_memory_highwater(1)] is the high-water mark +** prior to the reset. +*/ +SQLITE_API tdsqlite3_int64 tdsqlite3_memory_used(void); +SQLITE_API tdsqlite3_int64 tdsqlite3_memory_highwater(int resetFlag); + +/* +** CAPI3REF: Pseudo-Random Number Generator +** +** SQLite contains a high-quality pseudo-random number generator (PRNG) used to +** select random [ROWID | ROWIDs] when inserting new records into a table that +** already uses the largest possible [ROWID]. The PRNG is also used for +** the built-in random() and randomblob() SQL functions. This interface allows +** applications to access the same PRNG for other purposes. +** +** ^A call to this routine stores N bytes of randomness into buffer P. +** ^The P parameter can be a NULL pointer. +** +** ^If this routine has not been previously called or if the previous +** call had N less than one or a NULL pointer for P, then the PRNG is +** seeded using randomness obtained from the xRandomness method of +** the default [tdsqlite3_vfs] object. +** ^If the previous call to this routine had an N of 1 or more and a +** non-NULL P then the pseudo-randomness is generated +** internally and without recourse to the [tdsqlite3_vfs] xRandomness +** method. +*/ +SQLITE_API void tdsqlite3_randomness(int N, void *P); + +/* +** CAPI3REF: Compile-Time Authorization Callbacks +** METHOD: tdsqlite3 +** KEYWORDS: {authorizer callback} +** +** ^This routine registers an authorizer callback with a particular +** [database connection], supplied in the first argument. +** ^The authorizer callback is invoked as SQL statements are being compiled +** by [tdsqlite3_prepare()] or its variants [tdsqlite3_prepare_v2()], +** [tdsqlite3_prepare_v3()], [tdsqlite3_prepare16()], [tdsqlite3_prepare16_v2()], +** and [tdsqlite3_prepare16_v3()]. ^At various +** points during the compilation process, as logic is being created +** to perform various actions, the authorizer callback is invoked to +** see if those actions are allowed. ^The authorizer callback should +** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the +** specific action but allow the SQL statement to continue to be +** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be +** rejected with an error. ^If the authorizer callback returns +** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY] +** then the [tdsqlite3_prepare_v2()] or equivalent call that triggered +** the authorizer will fail with an error message. +** +** When the callback returns [SQLITE_OK], that means the operation +** requested is ok. ^When the callback returns [SQLITE_DENY], the +** [tdsqlite3_prepare_v2()] or equivalent call that triggered the +** authorizer will fail with an error message explaining that +** access is denied. +** +** ^The first parameter to the authorizer callback is a copy of the third +** parameter to the tdsqlite3_set_authorizer() interface. ^The second parameter +** to the callback is an integer [SQLITE_COPY | action code] that specifies +** the particular action to be authorized. ^The third through sixth parameters +** to the callback are either NULL pointers or zero-terminated strings +** that contain additional details about the action to be authorized. +** Applications must always be prepared to encounter a NULL pointer in any +** of the third through the sixth parameters of the authorization callback. +** +** ^If the action code is [SQLITE_READ] +** and the callback returns [SQLITE_IGNORE] then the +** [prepared statement] statement is constructed to substitute +** a NULL value in place of the table column that would have +** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE] +** return can be used to deny an untrusted user access to individual +** columns of a table. +** ^When a table is referenced by a [SELECT] but no column values are +** extracted from that table (for example in a query like +** "SELECT count(*) FROM tab") then the [SQLITE_READ] authorizer callback +** is invoked once for that table with a column name that is an empty string. +** ^If the action code is [SQLITE_DELETE] and the callback returns +** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the +** [truncate optimization] is disabled and all rows are deleted individually. +** +** An authorizer is used when [tdsqlite3_prepare | preparing] +** SQL statements from an untrusted source, to ensure that the SQL statements +** do not try to access data they are not allowed to see, or that they do not +** try to execute malicious statements that damage the database. For +** example, an application may allow a user to enter arbitrary +** SQL queries for evaluation by a database. But the application does +** not want the user to be able to make arbitrary changes to the +** database. An authorizer could then be put in place while the +** user-entered SQL is being [tdsqlite3_prepare | prepared] that +** disallows everything except [SELECT] statements. +** +** Applications that need to process SQL from untrusted sources +** might also consider lowering resource limits using [tdsqlite3_limit()] +** and limiting database size using the [max_page_count] [PRAGMA] +** in addition to using an authorizer. +** +** ^(Only a single authorizer can be in place on a database connection +** at a time. Each call to tdsqlite3_set_authorizer overrides the +** previous call.)^ ^Disable the authorizer by installing a NULL callback. +** The authorizer is disabled by default. +** +** The authorizer callback must not do anything that will modify +** the database connection that invoked the authorizer callback. +** Note that [tdsqlite3_prepare_v2()] and [tdsqlite3_step()] both modify their +** database connections for the meaning of "modify" in this paragraph. +** +** ^When [tdsqlite3_prepare_v2()] is used to prepare a statement, the +** statement might be re-prepared during [tdsqlite3_step()] due to a +** schema change. Hence, the application should ensure that the +** correct authorizer callback remains in place during the [tdsqlite3_step()]. +** +** ^Note that the authorizer callback is invoked only during +** [tdsqlite3_prepare()] or its variants. Authorization is not +** performed during statement evaluation in [tdsqlite3_step()], unless +** as stated in the previous paragraph, tdsqlite3_step() invokes +** tdsqlite3_prepare_v2() to reprepare a statement after a schema change. +*/ +SQLITE_API int tdsqlite3_set_authorizer( + tdsqlite3*, + int (*xAuth)(void*,int,const char*,const char*,const char*,const char*), + void *pUserData +); + +/* +** CAPI3REF: Authorizer Return Codes +** +** The [tdsqlite3_set_authorizer | authorizer callback function] must +** return either [SQLITE_OK] or one of these two constants in order +** to signal SQLite whether or not the action is permitted. See the +** [tdsqlite3_set_authorizer | authorizer documentation] for additional +** information. +** +** Note that SQLITE_IGNORE is also used as a [conflict resolution mode] +** returned from the [tdsqlite3_vtab_on_conflict()] interface. +*/ +#define SQLITE_DENY 1 /* Abort the SQL statement with an error */ +#define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */ + +/* +** CAPI3REF: Authorizer Action Codes +** +** The [tdsqlite3_set_authorizer()] interface registers a callback function +** that is invoked to authorize certain SQL statement actions. The +** second parameter to the callback is an integer code that specifies +** what action is being authorized. These are the integer action codes that +** the authorizer callback may be passed. +** +** These action code values signify what kind of operation is to be +** authorized. The 3rd and 4th parameters to the authorization +** callback function will be parameters or NULL depending on which of these +** codes is used as the second parameter. ^(The 5th parameter to the +** authorizer callback is the name of the database ("main", "temp", +** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback +** is the name of the inner-most trigger or view that is responsible for +** the access attempt or NULL if this access attempt is directly from +** top-level SQL code. +*/ +/******************************************* 3rd ************ 4th ***********/ +#define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */ +#define SQLITE_CREATE_TABLE 2 /* Table Name NULL */ +#define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */ +#define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */ +#define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */ +#define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */ +#define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */ +#define SQLITE_CREATE_VIEW 8 /* View Name NULL */ +#define SQLITE_DELETE 9 /* Table Name NULL */ +#define SQLITE_DROP_INDEX 10 /* Index Name Table Name */ +#define SQLITE_DROP_TABLE 11 /* Table Name NULL */ +#define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */ +#define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */ +#define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */ +#define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */ +#define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */ +#define SQLITE_DROP_VIEW 17 /* View Name NULL */ +#define SQLITE_INSERT 18 /* Table Name NULL */ +#define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */ +#define SQLITE_READ 20 /* Table Name Column Name */ +#define SQLITE_SELECT 21 /* NULL NULL */ +#define SQLITE_TRANSACTION 22 /* Operation NULL */ +#define SQLITE_UPDATE 23 /* Table Name Column Name */ +#define SQLITE_ATTACH 24 /* Filename NULL */ +#define SQLITE_DETACH 25 /* Database Name NULL */ +#define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */ +#define SQLITE_REINDEX 27 /* Index Name NULL */ +#define SQLITE_ANALYZE 28 /* Table Name NULL */ +#define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */ +#define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */ +#define SQLITE_FUNCTION 31 /* NULL Function Name */ +#define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */ +#define SQLITE_COPY 0 /* No longer used */ +#define SQLITE_RECURSIVE 33 /* NULL NULL */ + +/* +** CAPI3REF: Tracing And Profiling Functions +** METHOD: tdsqlite3 +** +** These routines are deprecated. Use the [tdsqlite3_trace_v2()] interface +** instead of the routines described here. +** +** These routines register callback functions that can be used for +** tracing and profiling the execution of SQL statements. +** +** ^The callback function registered by tdsqlite3_trace() is invoked at +** various times when an SQL statement is being run by [tdsqlite3_step()]. +** ^The tdsqlite3_trace() callback is invoked with a UTF-8 rendering of the +** SQL statement text as the statement first begins executing. +** ^(Additional tdsqlite3_trace() callbacks might occur +** as each triggered subprogram is entered. The callbacks for triggers +** contain a UTF-8 SQL comment that identifies the trigger.)^ +** +** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit +** the length of [bound parameter] expansion in the output of tdsqlite3_trace(). +** +** ^The callback function registered by tdsqlite3_profile() is invoked +** as each SQL statement finishes. ^The profile callback contains +** the original statement text and an estimate of wall-clock time +** of how long that statement took to run. ^The profile callback +** time is in units of nanoseconds, however the current implementation +** is only capable of millisecond resolution so the six least significant +** digits in the time are meaningless. Future versions of SQLite +** might provide greater resolution on the profiler callback. Invoking +** either [tdsqlite3_trace()] or [tdsqlite3_trace_v2()] will cancel the +** profile callback. +*/ +SQLITE_API SQLITE_DEPRECATED void *tdsqlite3_trace(tdsqlite3*, + void(*xTrace)(void*,const char*), void*); +SQLITE_API SQLITE_DEPRECATED void *tdsqlite3_profile(tdsqlite3*, + void(*xProfile)(void*,const char*,tdsqlite3_uint64), void*); + +/* +** CAPI3REF: SQL Trace Event Codes +** KEYWORDS: SQLITE_TRACE +** +** These constants identify classes of events that can be monitored +** using the [tdsqlite3_trace_v2()] tracing logic. The M argument +** to [tdsqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of +** the following constants. ^The first argument to the trace callback +** is one of the following constants. +** +** New tracing constants may be added in future releases. +** +** ^A trace callback has four arguments: xCallback(T,C,P,X). +** ^The T argument is one of the integer type codes above. +** ^The C argument is a copy of the context pointer passed in as the +** fourth argument to [tdsqlite3_trace_v2()]. +** The P and X arguments are pointers whose meanings depend on T. +** +**
+** [[SQLITE_TRACE_STMT]]
SQLITE_TRACE_STMT
+**
^An SQLITE_TRACE_STMT callback is invoked when a prepared statement +** first begins running and possibly at other times during the +** execution of the prepared statement, such as at the start of each +** trigger subprogram. ^The P argument is a pointer to the +** [prepared statement]. ^The X argument is a pointer to a string which +** is the unexpanded SQL text of the prepared statement or an SQL comment +** that indicates the invocation of a trigger. ^The callback can compute +** the same text that would have been returned by the legacy [tdsqlite3_trace()] +** interface by using the X argument when X begins with "--" and invoking +** [tdsqlite3_expanded_sql(P)] otherwise. +** +** [[SQLITE_TRACE_PROFILE]]
SQLITE_TRACE_PROFILE
+**
^An SQLITE_TRACE_PROFILE callback provides approximately the same +** information as is provided by the [tdsqlite3_profile()] callback. +** ^The P argument is a pointer to the [prepared statement] and the +** X argument points to a 64-bit integer which is the estimated of +** the number of nanosecond that the prepared statement took to run. +** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes. +** +** [[SQLITE_TRACE_ROW]]
SQLITE_TRACE_ROW
+**
^An SQLITE_TRACE_ROW callback is invoked whenever a prepared +** statement generates a single row of result. +** ^The P argument is a pointer to the [prepared statement] and the +** X argument is unused. +** +** [[SQLITE_TRACE_CLOSE]]
SQLITE_TRACE_CLOSE
+**
^An SQLITE_TRACE_CLOSE callback is invoked when a database +** connection closes. +** ^The P argument is a pointer to the [database connection] object +** and the X argument is unused. +**
+*/ +#define SQLITE_TRACE_STMT 0x01 +#define SQLITE_TRACE_PROFILE 0x02 +#define SQLITE_TRACE_ROW 0x04 +#define SQLITE_TRACE_CLOSE 0x08 + +/* +** CAPI3REF: SQL Trace Hook +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_trace_v2(D,M,X,P) interface registers a trace callback +** function X against [database connection] D, using property mask M +** and context pointer P. ^If the X callback is +** NULL or if the M mask is zero, then tracing is disabled. The +** M argument should be the bitwise OR-ed combination of +** zero or more [SQLITE_TRACE] constants. +** +** ^Each call to either tdsqlite3_trace() or tdsqlite3_trace_v2() overrides +** (cancels) any prior calls to tdsqlite3_trace() or tdsqlite3_trace_v2(). +** +** ^The X callback is invoked whenever any of the events identified by +** mask M occur. ^The integer return value from the callback is currently +** ignored, though this may change in future releases. Callback +** implementations should return zero to ensure future compatibility. +** +** ^A trace callback is invoked with four arguments: callback(T,C,P,X). +** ^The T argument is one of the [SQLITE_TRACE] +** constants to indicate why the callback was invoked. +** ^The C argument is a copy of the context pointer. +** The P and X arguments are pointers whose meanings depend on T. +** +** The tdsqlite3_trace_v2() interface is intended to replace the legacy +** interfaces [tdsqlite3_trace()] and [tdsqlite3_profile()], both of which +** are deprecated. +*/ +SQLITE_API int tdsqlite3_trace_v2( + tdsqlite3*, + unsigned uMask, + int(*xCallback)(unsigned,void*,void*,void*), + void *pCtx +); + +/* +** CAPI3REF: Query Progress Callbacks +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_progress_handler(D,N,X,P) interface causes the callback +** function X to be invoked periodically during long running calls to +** [tdsqlite3_exec()], [tdsqlite3_step()] and [tdsqlite3_get_table()] for +** database connection D. An example use for this +** interface is to keep a GUI updated during a large query. +** +** ^The parameter P is passed through as the only parameter to the +** callback function X. ^The parameter N is the approximate number of +** [virtual machine instructions] that are evaluated between successive +** invocations of the callback X. ^If N is less than one then the progress +** handler is disabled. +** +** ^Only a single progress handler may be defined at one time per +** [database connection]; setting a new progress handler cancels the +** old one. ^Setting parameter X to NULL disables the progress handler. +** ^The progress handler is also disabled by setting N to a value less +** than 1. +** +** ^If the progress callback returns non-zero, the operation is +** interrupted. This feature can be used to implement a +** "Cancel" button on a GUI progress dialog box. +** +** The progress handler callback must not do anything that will modify +** the database connection that invoked the progress handler. +** Note that [tdsqlite3_prepare_v2()] and [tdsqlite3_step()] both modify their +** database connections for the meaning of "modify" in this paragraph. +** +*/ +SQLITE_API void tdsqlite3_progress_handler(tdsqlite3*, int, int(*)(void*), void*); + +/* +** CAPI3REF: Opening A New Database Connection +** CONSTRUCTOR: tdsqlite3 +** +** ^These routines open an SQLite database file as specified by the +** filename argument. ^The filename argument is interpreted as UTF-8 for +** tdsqlite3_open() and tdsqlite3_open_v2() and as UTF-16 in the native byte +** order for tdsqlite3_open16(). ^(A [database connection] handle is usually +** returned in *ppDb, even if an error occurs. The only exception is that +** if SQLite is unable to allocate memory to hold the [tdsqlite3] object, +** a NULL will be written into *ppDb instead of a pointer to the [tdsqlite3] +** object.)^ ^(If the database is opened (and/or created) successfully, then +** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The +** [tdsqlite3_errmsg()] or [tdsqlite3_errmsg16()] routines can be used to obtain +** an English language description of the error following a failure of any +** of the tdsqlite3_open() routines. +** +** ^The default encoding will be UTF-8 for databases created using +** tdsqlite3_open() or tdsqlite3_open_v2(). ^The default encoding for databases +** created using tdsqlite3_open16() will be UTF-16 in the native byte order. +** +** Whether or not an error occurs when it is opened, resources +** associated with the [database connection] handle should be released by +** passing it to [tdsqlite3_close()] when it is no longer required. +** +** The tdsqlite3_open_v2() interface works like tdsqlite3_open() +** except that it accepts two additional parameters for additional control +** over the new database connection. ^(The flags parameter to +** tdsqlite3_open_v2() must include, at a minimum, one of the following +** three flag combinations:)^ +** +**
+** ^(
[SQLITE_OPEN_READONLY]
+**
The database is opened in read-only mode. If the database does not +** already exist, an error is returned.
)^ +** +** ^(
[SQLITE_OPEN_READWRITE]
+**
The database is opened for reading and writing if possible, or reading +** only if the file is write protected by the operating system. In either +** case the database must already exist, otherwise an error is returned.
)^ +** +** ^(
[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]
+**
The database is opened for reading and writing, and is created if +** it does not already exist. This is the behavior that is always used for +** tdsqlite3_open() and tdsqlite3_open16().
)^ +**
+** +** In addition to the required flags, the following optional flags are +** also supported: +** +**
+** ^(
[SQLITE_OPEN_URI]
+**
The filename can be interpreted as a URI if this flag is set.
)^ +** +** ^(
[SQLITE_OPEN_MEMORY]
+**
The database will be opened as an in-memory database. The database +** is named by the "filename" argument for the purposes of cache-sharing, +** if shared cache mode is enabled, but the "filename" is otherwise ignored. +**
)^ +** +** ^(
[SQLITE_OPEN_NOMUTEX]
+**
The new database connection will use the "multi-thread" +** [threading mode].)^ This means that separate threads are allowed +** to use SQLite at the same time, as long as each thread is using +** a different [database connection]. +** +** ^(
[SQLITE_OPEN_FULLMUTEX]
+**
The new database connection will use the "serialized" +** [threading mode].)^ This means the multiple threads can safely +** attempt to use the same database connection at the same time. +** (Mutexes will block any actual concurrency, but in this mode +** there is no harm in trying.) +** +** ^(
[SQLITE_OPEN_SHAREDCACHE]
+**
The database is opened [shared cache] enabled, overriding +** the default shared cache setting provided by +** [tdsqlite3_enable_shared_cache()].)^ +** +** ^(
[SQLITE_OPEN_PRIVATECACHE]
+**
The database is opened [shared cache] disabled, overriding +** the default shared cache setting provided by +** [tdsqlite3_enable_shared_cache()].)^ +** +** [[OPEN_NOFOLLOW]] ^(
[SQLITE_OPEN_NOFOLLOW]
+**
The database filename is not allowed to be a symbolic link
+**
)^ +** +** If the 3rd parameter to tdsqlite3_open_v2() is not one of the +** required combinations shown above optionally combined with other +** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits] +** then the behavior is undefined. +** +** ^The fourth parameter to tdsqlite3_open_v2() is the name of the +** [tdsqlite3_vfs] object that defines the operating system interface that +** the new database connection should use. ^If the fourth parameter is +** a NULL pointer then the default [tdsqlite3_vfs] object is used. +** +** ^If the filename is ":memory:", then a private, temporary in-memory database +** is created for the connection. ^This in-memory database will vanish when +** the database connection is closed. Future versions of SQLite might +** make use of additional special filenames that begin with the ":" character. +** It is recommended that when a database filename actually does begin with +** a ":" character you should prefix the filename with a pathname such as +** "./" to avoid ambiguity. +** +** ^If the filename is an empty string, then a private, temporary +** on-disk database will be created. ^This private database will be +** automatically deleted as soon as the database connection is closed. +** +** [[URI filenames in tdsqlite3_open()]]

URI Filenames

+** +** ^If [URI filename] interpretation is enabled, and the filename argument +** begins with "file:", then the filename is interpreted as a URI. ^URI +** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is +** set in the third argument to tdsqlite3_open_v2(), or if it has +** been enabled globally using the [SQLITE_CONFIG_URI] option with the +** [tdsqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option. +** URI filename interpretation is turned off +** by default, but future releases of SQLite might enable URI filename +** interpretation by default. See "[URI filenames]" for additional +** information. +** +** URI filenames are parsed according to RFC 3986. ^If the URI contains an +** authority, then it must be either an empty string or the string +** "localhost". ^If the authority is not an empty string or "localhost", an +** error is returned to the caller. ^The fragment component of a URI, if +** present, is ignored. +** +** ^SQLite uses the path component of the URI as the name of the disk file +** which contains the database. ^If the path begins with a '/' character, +** then it is interpreted as an absolute path. ^If the path does not begin +** with a '/' (meaning that the authority section is omitted from the URI) +** then the path is interpreted as a relative path. +** ^(On windows, the first component of an absolute path +** is a drive specification (e.g. "C:").)^ +** +** [[core URI query parameters]] +** The query component of a URI may contain parameters that are interpreted +** either by SQLite itself, or by a [VFS | custom VFS implementation]. +** SQLite and its built-in [VFSes] interpret the +** following query parameters: +** +**
    +**
  • vfs: ^The "vfs" parameter may be used to specify the name of +** a VFS object that provides the operating system interface that should +** be used to access the database file on disk. ^If this option is set to +** an empty string the default VFS object is used. ^Specifying an unknown +** VFS is an error. ^If tdsqlite3_open_v2() is used and the vfs option is +** present, then the VFS specified by the option takes precedence over +** the value passed as the fourth parameter to tdsqlite3_open_v2(). +** +**
  • mode: ^(The mode parameter may be set to either "ro", "rw", +** "rwc", or "memory". Attempting to set it to any other value is +** an error)^. +** ^If "ro" is specified, then the database is opened for read-only +** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the +** third argument to tdsqlite3_open_v2(). ^If the mode option is set to +** "rw", then the database is opened for read-write (but not create) +** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had +** been set. ^Value "rwc" is equivalent to setting both +** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is +** set to "memory" then a pure [in-memory database] that never reads +** or writes from disk is used. ^It is an error to specify a value for +** the mode parameter that is less restrictive than that specified by +** the flags passed in the third parameter to tdsqlite3_open_v2(). +** +**
  • cache: ^The cache parameter may be set to either "shared" or +** "private". ^Setting it to "shared" is equivalent to setting the +** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to +** tdsqlite3_open_v2(). ^Setting the cache parameter to "private" is +** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit. +** ^If tdsqlite3_open_v2() is used and the "cache" parameter is present in +** a URI filename, its value overrides any behavior requested by setting +** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag. +** +**
  • psow: ^The psow parameter indicates whether or not the +** [powersafe overwrite] property does or does not apply to the +** storage media on which the database file resides. +** +**
  • nolock: ^The nolock parameter is a boolean query parameter +** which if set disables file locking in rollback journal modes. This +** is useful for accessing a database on a filesystem that does not +** support locking. Caution: Database corruption might result if two +** or more processes write to the same database and any one of those +** processes uses nolock=1. +** +**
  • immutable: ^The immutable parameter is a boolean query +** parameter that indicates that the database file is stored on +** read-only media. ^When immutable is set, SQLite assumes that the +** database file cannot be changed, even by a process with higher +** privilege, and so the database is opened read-only and all locking +** and change detection is disabled. Caution: Setting the immutable +** property on a database file that does in fact change can result +** in incorrect query results and/or [SQLITE_CORRUPT] errors. +** See also: [SQLITE_IOCAP_IMMUTABLE]. +** +**
+** +** ^Specifying an unknown parameter in the query component of a URI is not an +** error. Future versions of SQLite might understand additional query +** parameters. See "[query parameters with special meaning to SQLite]" for +** additional information. +** +** [[URI filename examples]]

URI filename examples

+** +** +**
URI filenames Results +**
file:data.db +** Open the file "data.db" in the current directory. +**
file:/home/fred/data.db
+** file:///home/fred/data.db
+** file://localhost/home/fred/data.db
+** Open the database file "/home/fred/data.db". +**
file://darkstar/home/fred/data.db +** An error. "darkstar" is not a recognized authority. +**
+** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db +** Windows only: Open the file "data.db" on fred's desktop on drive +** C:. Note that the %20 escaping in this example is not strictly +** necessary - space characters can be used literally +** in URI filenames. +**
file:data.db?mode=ro&cache=private +** Open file "data.db" in the current directory for read-only access. +** Regardless of whether or not shared-cache mode is enabled by +** default, use a private cache. +**
file:/home/fred/data.db?vfs=unix-dotfile +** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile" +** that uses dot-files in place of posix advisory locking. +**
file:data.db?mode=readonly +** An error. "readonly" is not a valid option for the "mode" parameter. +**
+** +** ^URI hexadecimal escape sequences (%HH) are supported within the path and +** query components of a URI. A hexadecimal escape sequence consists of a +** percent sign - "%" - followed by exactly two hexadecimal digits +** specifying an octet value. ^Before the path or query components of a +** URI filename are interpreted, they are encoded using UTF-8 and all +** hexadecimal escape sequences replaced by a single byte containing the +** corresponding octet. If this process generates an invalid UTF-8 encoding, +** the results are undefined. +** +** Note to Windows users: The encoding used for the filename argument +** of tdsqlite3_open() and tdsqlite3_open_v2() must be UTF-8, not whatever +** codepage is currently defined. Filenames containing international +** characters must be converted to UTF-8 prior to passing them into +** tdsqlite3_open() or tdsqlite3_open_v2(). +** +** Note to Windows Runtime users: The temporary directory must be set +** prior to calling tdsqlite3_open() or tdsqlite3_open_v2(). Otherwise, various +** features that require the use of temporary files may fail. +** +** See also: [tdsqlite3_temp_directory] +*/ +SQLITE_API int tdsqlite3_open( + const char *filename, /* Database filename (UTF-8) */ + tdsqlite3 **ppDb /* OUT: SQLite db handle */ +); +SQLITE_API int tdsqlite3_open16( + const void *filename, /* Database filename (UTF-16) */ + tdsqlite3 **ppDb /* OUT: SQLite db handle */ +); +SQLITE_API int tdsqlite3_open_v2( + const char *filename, /* Database filename (UTF-8) */ + tdsqlite3 **ppDb, /* OUT: SQLite db handle */ + int flags, /* Flags */ + const char *zVfs /* Name of VFS module to use */ +); + +/* +** CAPI3REF: Obtain Values For URI Parameters +** +** These are utility routines, useful to [VFS|custom VFS implementations], +** that check if a database file was a URI that contained a specific query +** parameter, and if so obtains the value of that query parameter. +** +** If F is the database filename pointer passed into the xOpen() method of +** a VFS implementation or it is the return value of [tdsqlite3_db_filename()] +** and if P is the name of the query parameter, then +** tdsqlite3_uri_parameter(F,P) returns the value of the P +** parameter if it exists or a NULL pointer if P does not appear as a +** query parameter on F. If P is a query parameter of F and it +** has no explicit value, then tdsqlite3_uri_parameter(F,P) returns +** a pointer to an empty string. +** +** The tdsqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean +** parameter and returns true (1) or false (0) according to the value +** of P. The tdsqlite3_uri_boolean(F,P,B) routine returns true (1) if the +** value of query parameter P is one of "yes", "true", or "on" in any +** case or if the value begins with a non-zero number. The +** tdsqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of +** query parameter P is one of "no", "false", or "off" in any case or +** if the value begins with a numeric zero. If P is not a query +** parameter on F or if the value of P does not match any of the +** above, then tdsqlite3_uri_boolean(F,P,B) returns (B!=0). +** +** The tdsqlite3_uri_int64(F,P,D) routine converts the value of P into a +** 64-bit signed integer and returns that integer, or D if P does not +** exist. If the value of P is something other than an integer, then +** zero is returned. +** +** The tdsqlite3_uri_key(F,N) returns a pointer to the name (not +** the value) of the N-th query parameter for filename F, or a NULL +** pointer if N is less than zero or greater than the number of query +** parameters minus 1. The N value is zero-based so N should be 0 to obtain +** the name of the first query parameter, 1 for the second parameter, and +** so forth. +** +** If F is a NULL pointer, then tdsqlite3_uri_parameter(F,P) returns NULL and +** tdsqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and +** is not a database file pathname pointer that the SQLite core passed +** into the xOpen VFS method, then the behavior of this routine is undefined +** and probably undesirable. +** +** Beginning with SQLite [version 3.31.0] ([dateof:3.31.0]) the input F +** parameter can also be the name of a rollback journal file or WAL file +** in addition to the main database file. Prior to version 3.31.0, these +** routines would only work if F was the name of the main database file. +** When the F parameter is the name of the rollback journal or WAL file, +** it has access to all the same query parameters as were found on the +** main database file. +** +** See the [URI filename] documentation for additional information. +*/ +SQLITE_API const char *tdsqlite3_uri_parameter(const char *zFilename, const char *zParam); +SQLITE_API int tdsqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault); +SQLITE_API tdsqlite3_int64 tdsqlite3_uri_int64(const char*, const char*, tdsqlite3_int64); +SQLITE_API const char *tdsqlite3_uri_key(const char *zFilename, int N); + +/* +** CAPI3REF: Translate filenames +** +** These routines are available to [VFS|custom VFS implementations] for +** translating filenames between the main database file, the journal file, +** and the WAL file. +** +** If F is the name of an sqlite database file, journal file, or WAL file +** passed by the SQLite core into the VFS, then tdsqlite3_filename_database(F) +** returns the name of the corresponding database file. +** +** If F is the name of an sqlite database file, journal file, or WAL file +** passed by the SQLite core into the VFS, or if F is a database filename +** obtained from [tdsqlite3_db_filename()], then tdsqlite3_filename_journal(F) +** returns the name of the corresponding rollback journal file. +** +** If F is the name of an sqlite database file, journal file, or WAL file +** that was passed by the SQLite core into the VFS, or if F is a database +** filename obtained from [tdsqlite3_db_filename()], then +** tdsqlite3_filename_wal(F) returns the name of the corresponding +** WAL file. +** +** In all of the above, if F is not the name of a database, journal or WAL +** filename passed into the VFS from the SQLite core and F is not the +** return value from [tdsqlite3_db_filename()], then the result is +** undefined and is likely a memory access violation. +*/ +SQLITE_API const char *tdsqlite3_filename_database(const char*); +SQLITE_API const char *tdsqlite3_filename_journal(const char*); +SQLITE_API const char *tdsqlite3_filename_wal(const char*); + + +/* +** CAPI3REF: Error Codes And Messages +** METHOD: tdsqlite3 +** +** ^If the most recent tdsqlite3_* API call associated with +** [database connection] D failed, then the tdsqlite3_errcode(D) interface +** returns the numeric [result code] or [extended result code] for that +** API call. +** ^The tdsqlite3_extended_errcode() +** interface is the same except that it always returns the +** [extended result code] even when extended result codes are +** disabled. +** +** The values returned by tdsqlite3_errcode() and/or +** tdsqlite3_extended_errcode() might change with each API call. +** Except, there are some interfaces that are guaranteed to never +** change the value of the error code. The error-code preserving +** interfaces are: +** +**
    +**
  • tdsqlite3_errcode() +**
  • tdsqlite3_extended_errcode() +**
  • tdsqlite3_errmsg() +**
  • tdsqlite3_errmsg16() +**
+** +** ^The tdsqlite3_errmsg() and tdsqlite3_errmsg16() return English-language +** text that describes the error, as either UTF-8 or UTF-16 respectively. +** ^(Memory to hold the error message string is managed internally. +** The application does not need to worry about freeing the result. +** However, the error string might be overwritten or deallocated by +** subsequent calls to other SQLite interface functions.)^ +** +** ^The tdsqlite3_errstr() interface returns the English-language text +** that describes the [result code], as UTF-8. +** ^(Memory to hold the error message string is managed internally +** and must not be freed by the application)^. +** +** When the serialized [threading mode] is in use, it might be the +** case that a second error occurs on a separate thread in between +** the time of the first error and the call to these interfaces. +** When that happens, the second error will be reported since these +** interfaces always report the most recent result. To avoid +** this, each thread can obtain exclusive use of the [database connection] D +** by invoking [tdsqlite3_mutex_enter]([tdsqlite3_db_mutex](D)) before beginning +** to use D and invoking [tdsqlite3_mutex_leave]([tdsqlite3_db_mutex](D)) after +** all calls to the interfaces listed here are completed. +** +** If an interface fails with SQLITE_MISUSE, that means the interface +** was invoked incorrectly by the application. In that case, the +** error code and message may or may not be set. +*/ +SQLITE_API int tdsqlite3_errcode(tdsqlite3 *db); +SQLITE_API int tdsqlite3_extended_errcode(tdsqlite3 *db); +SQLITE_API const char *tdsqlite3_errmsg(tdsqlite3*); +SQLITE_API const void *tdsqlite3_errmsg16(tdsqlite3*); +SQLITE_API const char *tdsqlite3_errstr(int); + +/* +** CAPI3REF: Prepared Statement Object +** KEYWORDS: {prepared statement} {prepared statements} +** +** An instance of this object represents a single SQL statement that +** has been compiled into binary form and is ready to be evaluated. +** +** Think of each SQL statement as a separate computer program. The +** original SQL text is source code. A prepared statement object +** is the compiled object code. All SQL must be converted into a +** prepared statement before it can be run. +** +** The life-cycle of a prepared statement object usually goes like this: +** +**
    +**
  1. Create the prepared statement object using [tdsqlite3_prepare_v2()]. +**
  2. Bind values to [parameters] using the tdsqlite3_bind_*() +** interfaces. +**
  3. Run the SQL by calling [tdsqlite3_step()] one or more times. +**
  4. Reset the prepared statement using [tdsqlite3_reset()] then go back +** to step 2. Do this zero or more times. +**
  5. Destroy the object using [tdsqlite3_finalize()]. +**
+*/ +typedef struct tdsqlite3_stmt tdsqlite3_stmt; + +/* +** CAPI3REF: Run-time Limits +** METHOD: tdsqlite3 +** +** ^(This interface allows the size of various constructs to be limited +** on a connection by connection basis. The first parameter is the +** [database connection] whose limit is to be set or queried. The +** second parameter is one of the [limit categories] that define a +** class of constructs to be size limited. The third parameter is the +** new limit for that construct.)^ +** +** ^If the new limit is a negative number, the limit is unchanged. +** ^(For each limit category SQLITE_LIMIT_NAME there is a +** [limits | hard upper bound] +** set at compile-time by a C preprocessor macro called +** [limits | SQLITE_MAX_NAME]. +** (The "_LIMIT_" in the name is changed to "_MAX_".))^ +** ^Attempts to increase a limit above its hard upper bound are +** silently truncated to the hard upper bound. +** +** ^Regardless of whether or not the limit was changed, the +** [tdsqlite3_limit()] interface returns the prior value of the limit. +** ^Hence, to find the current value of a limit without changing it, +** simply invoke this interface with the third parameter set to -1. +** +** Run-time limits are intended for use in applications that manage +** both their own internal database and also databases that are controlled +** by untrusted external sources. An example application might be a +** web browser that has its own databases for storing history and +** separate databases controlled by JavaScript applications downloaded +** off the Internet. The internal databases can be given the +** large, default limits. Databases managed by external sources can +** be given much smaller limits designed to prevent a denial of service +** attack. Developers might also want to use the [tdsqlite3_set_authorizer()] +** interface to further control untrusted SQL. The size of the database +** created by an untrusted script can be contained using the +** [max_page_count] [PRAGMA]. +** +** New run-time limit categories may be added in future releases. +*/ +SQLITE_API int tdsqlite3_limit(tdsqlite3*, int id, int newVal); + +/* +** CAPI3REF: Run-Time Limit Categories +** KEYWORDS: {limit category} {*limit categories} +** +** These constants define various performance limits +** that can be lowered at run-time using [tdsqlite3_limit()]. +** The synopsis of the meanings of the various limits is shown below. +** Additional information is available at [limits | Limits in SQLite]. +** +**
+** [[SQLITE_LIMIT_LENGTH]] ^(
SQLITE_LIMIT_LENGTH
+**
The maximum size of any string or BLOB or table row, in bytes.
)^ +** +** [[SQLITE_LIMIT_SQL_LENGTH]] ^(
SQLITE_LIMIT_SQL_LENGTH
+**
The maximum length of an SQL statement, in bytes.
)^ +** +** [[SQLITE_LIMIT_COLUMN]] ^(
SQLITE_LIMIT_COLUMN
+**
The maximum number of columns in a table definition or in the +** result set of a [SELECT] or the maximum number of columns in an index +** or in an ORDER BY or GROUP BY clause.
)^ +** +** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(
SQLITE_LIMIT_EXPR_DEPTH
+**
The maximum depth of the parse tree on any expression.
)^ +** +** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(
SQLITE_LIMIT_COMPOUND_SELECT
+**
The maximum number of terms in a compound SELECT statement.
)^ +** +** [[SQLITE_LIMIT_VDBE_OP]] ^(
SQLITE_LIMIT_VDBE_OP
+**
The maximum number of instructions in a virtual machine program +** used to implement an SQL statement. If [tdsqlite3_prepare_v2()] or +** the equivalent tries to allocate space for more than this many opcodes +** in a single prepared statement, an SQLITE_NOMEM error is returned.
)^ +** +** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(
SQLITE_LIMIT_FUNCTION_ARG
+**
The maximum number of arguments on a function.
)^ +** +** [[SQLITE_LIMIT_ATTACHED]] ^(
SQLITE_LIMIT_ATTACHED
+**
The maximum number of [ATTACH | attached databases].)^
+** +** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]] +** ^(
SQLITE_LIMIT_LIKE_PATTERN_LENGTH
+**
The maximum length of the pattern argument to the [LIKE] or +** [GLOB] operators.
)^ +** +** [[SQLITE_LIMIT_VARIABLE_NUMBER]] +** ^(
SQLITE_LIMIT_VARIABLE_NUMBER
+**
The maximum index number of any [parameter] in an SQL statement.)^ +** +** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(
SQLITE_LIMIT_TRIGGER_DEPTH
+**
The maximum depth of recursion for triggers.
)^ +** +** [[SQLITE_LIMIT_WORKER_THREADS]] ^(
SQLITE_LIMIT_WORKER_THREADS
+**
The maximum number of auxiliary worker threads that a single +** [prepared statement] may start.
)^ +**
+*/ +#define SQLITE_LIMIT_LENGTH 0 +#define SQLITE_LIMIT_SQL_LENGTH 1 +#define SQLITE_LIMIT_COLUMN 2 +#define SQLITE_LIMIT_EXPR_DEPTH 3 +#define SQLITE_LIMIT_COMPOUND_SELECT 4 +#define SQLITE_LIMIT_VDBE_OP 5 +#define SQLITE_LIMIT_FUNCTION_ARG 6 +#define SQLITE_LIMIT_ATTACHED 7 +#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8 +#define SQLITE_LIMIT_VARIABLE_NUMBER 9 +#define SQLITE_LIMIT_TRIGGER_DEPTH 10 +#define SQLITE_LIMIT_WORKER_THREADS 11 + +/* +** CAPI3REF: Prepare Flags +** +** These constants define various flags that can be passed into +** "prepFlags" parameter of the [tdsqlite3_prepare_v3()] and +** [tdsqlite3_prepare16_v3()] interfaces. +** +** New flags may be added in future releases of SQLite. +** +**
+** [[SQLITE_PREPARE_PERSISTENT]] ^(
SQLITE_PREPARE_PERSISTENT
+**
The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner +** that the prepared statement will be retained for a long time and +** probably reused many times.)^ ^Without this flag, [tdsqlite3_prepare_v3()] +** and [tdsqlite3_prepare16_v3()] assume that the prepared statement will +** be used just once or at most a few times and then destroyed using +** [tdsqlite3_finalize()] relatively soon. The current implementation acts +** on this hint by avoiding the use of [lookaside memory] so as not to +** deplete the limited store of lookaside memory. Future versions of +** SQLite may act on this hint differently. +** +** [[SQLITE_PREPARE_NORMALIZE]]
SQLITE_PREPARE_NORMALIZE
+**
The SQLITE_PREPARE_NORMALIZE flag is a no-op. This flag used +** to be required for any prepared statement that wanted to use the +** [tdsqlite3_normalized_sql()] interface. However, the +** [tdsqlite3_normalized_sql()] interface is now available to all +** prepared statements, regardless of whether or not they use this +** flag. +** +** [[SQLITE_PREPARE_NO_VTAB]]
SQLITE_PREPARE_NO_VTAB
+**
The SQLITE_PREPARE_NO_VTAB flag causes the SQL compiler +** to return an error (error code SQLITE_ERROR) if the statement uses +** any virtual tables. +**
+*/ +#define SQLITE_PREPARE_PERSISTENT 0x01 +#define SQLITE_PREPARE_NORMALIZE 0x02 +#define SQLITE_PREPARE_NO_VTAB 0x04 + +/* +** CAPI3REF: Compiling An SQL Statement +** KEYWORDS: {SQL statement compiler} +** METHOD: tdsqlite3 +** CONSTRUCTOR: tdsqlite3_stmt +** +** To execute an SQL statement, it must first be compiled into a byte-code +** program using one of these routines. Or, in other words, these routines +** are constructors for the [prepared statement] object. +** +** The preferred routine to use is [tdsqlite3_prepare_v2()]. The +** [tdsqlite3_prepare()] interface is legacy and should be avoided. +** [tdsqlite3_prepare_v3()] has an extra "prepFlags" option that is used +** for special purposes. +** +** The use of the UTF-8 interfaces is preferred, as SQLite currently +** does all parsing using UTF-8. The UTF-16 interfaces are provided +** as a convenience. The UTF-16 interfaces work by converting the +** input text into UTF-8, then invoking the corresponding UTF-8 interface. +** +** The first argument, "db", is a [database connection] obtained from a +** prior successful call to [tdsqlite3_open()], [tdsqlite3_open_v2()] or +** [tdsqlite3_open16()]. The database connection must not have been closed. +** +** The second argument, "zSql", is the statement to be compiled, encoded +** as either UTF-8 or UTF-16. The tdsqlite3_prepare(), tdsqlite3_prepare_v2(), +** and tdsqlite3_prepare_v3() +** interfaces use UTF-8, and tdsqlite3_prepare16(), tdsqlite3_prepare16_v2(), +** and tdsqlite3_prepare16_v3() use UTF-16. +** +** ^If the nByte argument is negative, then zSql is read up to the +** first zero terminator. ^If nByte is positive, then it is the +** number of bytes read from zSql. ^If nByte is zero, then no prepared +** statement is generated. +** If the caller knows that the supplied string is nul-terminated, then +** there is a small performance advantage to passing an nByte parameter that +** is the number of bytes in the input string including +** the nul-terminator. +** +** ^If pzTail is not NULL then *pzTail is made to point to the first byte +** past the end of the first SQL statement in zSql. These routines only +** compile the first statement in zSql, so *pzTail is left pointing to +** what remains uncompiled. +** +** ^*ppStmt is left pointing to a compiled [prepared statement] that can be +** executed using [tdsqlite3_step()]. ^If there is an error, *ppStmt is set +** to NULL. ^If the input text contains no SQL (if the input is an empty +** string or a comment) then *ppStmt is set to NULL. +** The calling procedure is responsible for deleting the compiled +** SQL statement using [tdsqlite3_finalize()] after it has finished with it. +** ppStmt may not be NULL. +** +** ^On success, the tdsqlite3_prepare() family of routines return [SQLITE_OK]; +** otherwise an [error code] is returned. +** +** The tdsqlite3_prepare_v2(), tdsqlite3_prepare_v3(), tdsqlite3_prepare16_v2(), +** and tdsqlite3_prepare16_v3() interfaces are recommended for all new programs. +** The older interfaces (tdsqlite3_prepare() and tdsqlite3_prepare16()) +** are retained for backwards compatibility, but their use is discouraged. +** ^In the "vX" interfaces, the prepared statement +** that is returned (the [tdsqlite3_stmt] object) contains a copy of the +** original SQL text. This causes the [tdsqlite3_step()] interface to +** behave differently in three ways: +** +**
    +**
  1. +** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it +** always used to do, [tdsqlite3_step()] will automatically recompile the SQL +** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY] +** retries will occur before tdsqlite3_step() gives up and returns an error. +**
    2. +** +**
  2. +** ^When an error occurs, [tdsqlite3_step()] will return one of the detailed +** [error codes] or [extended error codes]. ^The legacy behavior was that +** [tdsqlite3_step()] would only return a generic [SQLITE_ERROR] result code +** and the application would have to make a second call to [tdsqlite3_reset()] +** in order to find the underlying cause of the problem. With the "v2" prepare +** interfaces, the underlying reason for the error is returned immediately. +**
    3. +** +**
  3. +** ^If the specific value bound to a [parameter | host parameter] in the +** WHERE clause might influence the choice of query plan for a statement, +** then the statement will be automatically recompiled, as if there had been +** a schema change, on the first [tdsqlite3_step()] call following any change +** to the [tdsqlite3_bind_text | bindings] of that [parameter]. +** ^The specific value of a WHERE-clause [parameter] might influence the +** choice of query plan if the parameter is the left-hand side of a [LIKE] +** or [GLOB] operator or if the parameter is compared to an indexed column +** and the [SQLITE_ENABLE_STAT4] compile-time option is enabled. +**
    4. +**
+** +**

^tdsqlite3_prepare_v3() differs from tdsqlite3_prepare_v2() only in having +** the extra prepFlags parameter, which is a bit array consisting of zero or +** more of the [SQLITE_PREPARE_PERSISTENT|SQLITE_PREPARE_*] flags. ^The +** tdsqlite3_prepare_v2() interface works exactly the same as +** tdsqlite3_prepare_v3() with a zero prepFlags parameter. +*/ +SQLITE_API int tdsqlite3_prepare( + tdsqlite3 *db, /* Database handle */ + const char *zSql, /* SQL statement, UTF-8 encoded */ + int nByte, /* Maximum length of zSql in bytes. */ + tdsqlite3_stmt **ppStmt, /* OUT: Statement handle */ + const char **pzTail /* OUT: Pointer to unused portion of zSql */ +); +SQLITE_API int tdsqlite3_prepare_v2( + tdsqlite3 *db, /* Database handle */ + const char *zSql, /* SQL statement, UTF-8 encoded */ + int nByte, /* Maximum length of zSql in bytes. */ + tdsqlite3_stmt **ppStmt, /* OUT: Statement handle */ + const char **pzTail /* OUT: Pointer to unused portion of zSql */ +); +SQLITE_API int tdsqlite3_prepare_v3( + tdsqlite3 *db, /* Database handle */ + const char *zSql, /* SQL statement, UTF-8 encoded */ + int nByte, /* Maximum length of zSql in bytes. */ + unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */ + tdsqlite3_stmt **ppStmt, /* OUT: Statement handle */ + const char **pzTail /* OUT: Pointer to unused portion of zSql */ +); +SQLITE_API int tdsqlite3_prepare16( + tdsqlite3 *db, /* Database handle */ + const void *zSql, /* SQL statement, UTF-16 encoded */ + int nByte, /* Maximum length of zSql in bytes. */ + tdsqlite3_stmt **ppStmt, /* OUT: Statement handle */ + const void **pzTail /* OUT: Pointer to unused portion of zSql */ +); +SQLITE_API int tdsqlite3_prepare16_v2( + tdsqlite3 *db, /* Database handle */ + const void *zSql, /* SQL statement, UTF-16 encoded */ + int nByte, /* Maximum length of zSql in bytes. */ + tdsqlite3_stmt **ppStmt, /* OUT: Statement handle */ + const void **pzTail /* OUT: Pointer to unused portion of zSql */ +); +SQLITE_API int tdsqlite3_prepare16_v3( + tdsqlite3 *db, /* Database handle */ + const void *zSql, /* SQL statement, UTF-16 encoded */ + int nByte, /* Maximum length of zSql in bytes. */ + unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */ + tdsqlite3_stmt **ppStmt, /* OUT: Statement handle */ + const void **pzTail /* OUT: Pointer to unused portion of zSql */ +); + +/* +** CAPI3REF: Retrieving Statement SQL +** METHOD: tdsqlite3_stmt +** +** ^The tdsqlite3_sql(P) interface returns a pointer to a copy of the UTF-8 +** SQL text used to create [prepared statement] P if P was +** created by [tdsqlite3_prepare_v2()], [tdsqlite3_prepare_v3()], +** [tdsqlite3_prepare16_v2()], or [tdsqlite3_prepare16_v3()]. +** ^The tdsqlite3_expanded_sql(P) interface returns a pointer to a UTF-8 +** string containing the SQL text of prepared statement P with +** [bound parameters] expanded. +** ^The tdsqlite3_normalized_sql(P) interface returns a pointer to a UTF-8 +** string containing the normalized SQL text of prepared statement P. The +** semantics used to normalize a SQL statement are unspecified and subject +** to change. At a minimum, literal values will be replaced with suitable +** placeholders. +** +** ^(For example, if a prepared statement is created using the SQL +** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345 +** and parameter :xyz is unbound, then tdsqlite3_sql() will return +** the original string, "SELECT $abc,:xyz" but tdsqlite3_expanded_sql() +** will return "SELECT 2345,NULL".)^ +** +** ^The tdsqlite3_expanded_sql() interface returns NULL if insufficient memory +** is available to hold the result, or if the result would exceed the +** the maximum string length determined by the [SQLITE_LIMIT_LENGTH]. +** +** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of +** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time +** option causes tdsqlite3_expanded_sql() to always return NULL. +** +** ^The strings returned by tdsqlite3_sql(P) and tdsqlite3_normalized_sql(P) +** are managed by SQLite and are automatically freed when the prepared +** statement is finalized. +** ^The string returned by tdsqlite3_expanded_sql(P), on the other hand, +** is obtained from [tdsqlite3_malloc()] and must be free by the application +** by passing it to [tdsqlite3_free()]. +*/ +SQLITE_API const char *tdsqlite3_sql(tdsqlite3_stmt *pStmt); +SQLITE_API char *tdsqlite3_expanded_sql(tdsqlite3_stmt *pStmt); +SQLITE_API const char *tdsqlite3_normalized_sql(tdsqlite3_stmt *pStmt); + +/* +** CAPI3REF: Determine If An SQL Statement Writes The Database +** METHOD: tdsqlite3_stmt +** +** ^The tdsqlite3_stmt_readonly(X) interface returns true (non-zero) if +** and only if the [prepared statement] X makes no direct changes to +** the content of the database file. +** +** Note that [application-defined SQL functions] or +** [virtual tables] might change the database indirectly as a side effect. +** ^(For example, if an application defines a function "eval()" that +** calls [tdsqlite3_exec()], then the following SQL statement would +** change the database file through side-effects: +** +** 

+**    SELECT eval('DELETE FROM t1') FROM t2;
+**
+** +** But because the [SELECT] statement does not change the database file +** directly, tdsqlite3_stmt_readonly() would still return true.)^ +** +** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK], +** [SAVEPOINT], and [RELEASE] cause tdsqlite3_stmt_readonly() to return true, +** since the statements themselves do not actually modify the database but +** rather they control the timing of when other statements modify the +** database. ^The [ATTACH] and [DETACH] statements also cause +** tdsqlite3_stmt_readonly() to return true since, while those statements +** change the configuration of a database connection, they do not make +** changes to the content of the database files on disk. +** ^The tdsqlite3_stmt_readonly() interface returns true for [BEGIN] since +** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and +** [BEGIN|BEGIN EXCLUSIVE] commands do touch the database and so +** tdsqlite3_stmt_readonly() returns false for those commands. +*/ +SQLITE_API int tdsqlite3_stmt_readonly(tdsqlite3_stmt *pStmt); + +/* +** CAPI3REF: Query The EXPLAIN Setting For A Prepared Statement +** METHOD: tdsqlite3_stmt +** +** ^The tdsqlite3_stmt_isexplain(S) interface returns 1 if the +** prepared statement S is an EXPLAIN statement, or 2 if the +** statement S is an EXPLAIN QUERY PLAN. +** ^The tdsqlite3_stmt_isexplain(S) interface returns 0 if S is +** an ordinary statement or a NULL pointer. +*/ +SQLITE_API int tdsqlite3_stmt_isexplain(tdsqlite3_stmt *pStmt); + +/* +** CAPI3REF: Determine If A Prepared Statement Has Been Reset +** METHOD: tdsqlite3_stmt +** +** ^The tdsqlite3_stmt_busy(S) interface returns true (non-zero) if the +** [prepared statement] S has been stepped at least once using +** [tdsqlite3_step(S)] but has neither run to completion (returned +** [SQLITE_DONE] from [tdsqlite3_step(S)]) nor +** been reset using [tdsqlite3_reset(S)]. ^The tdsqlite3_stmt_busy(S) +** interface returns false if S is a NULL pointer. If S is not a +** NULL pointer and is not a pointer to a valid [prepared statement] +** object, then the behavior is undefined and probably undesirable. +** +** This interface can be used in combination [tdsqlite3_next_stmt()] +** to locate all prepared statements associated with a database +** connection that are in need of being reset. This can be used, +** for example, in diagnostic routines to search for prepared +** statements that are holding a transaction open. +*/ +SQLITE_API int tdsqlite3_stmt_busy(tdsqlite3_stmt*); + +/* +** CAPI3REF: Dynamically Typed Value Object +** KEYWORDS: {protected tdsqlite3_value} {unprotected tdsqlite3_value} +** +** SQLite uses the tdsqlite3_value object to represent all values +** that can be stored in a database table. SQLite uses dynamic typing +** for the values it stores. ^Values stored in tdsqlite3_value objects +** can be integers, floating point values, strings, BLOBs, or NULL. +** +** An tdsqlite3_value object may be either "protected" or "unprotected". +** Some interfaces require a protected tdsqlite3_value. Other interfaces +** will accept either a protected or an unprotected tdsqlite3_value. +** Every interface that accepts tdsqlite3_value arguments specifies +** whether or not it requires a protected tdsqlite3_value. The +** [tdsqlite3_value_dup()] interface can be used to construct a new +** protected tdsqlite3_value from an unprotected tdsqlite3_value. +** +** The terms "protected" and "unprotected" refer to whether or not +** a mutex is held. An internal mutex is held for a protected +** tdsqlite3_value object but no mutex is held for an unprotected +** tdsqlite3_value object. If SQLite is compiled to be single-threaded +** (with [SQLITE_THREADSAFE=0] and with [tdsqlite3_threadsafe()] returning 0) +** or if SQLite is run in one of reduced mutex modes +** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD] +** then there is no distinction between protected and unprotected +** tdsqlite3_value objects and they can be used interchangeably. However, +** for maximum code portability it is recommended that applications +** still make the distinction between protected and unprotected +** tdsqlite3_value objects even when not strictly required. +** +** ^The tdsqlite3_value objects that are passed as parameters into the +** implementation of [application-defined SQL functions] are protected. +** ^The tdsqlite3_value object returned by +** [tdsqlite3_column_value()] is unprotected. +** Unprotected tdsqlite3_value objects may only be used as arguments +** to [tdsqlite3_result_value()], [tdsqlite3_bind_value()], and +** [tdsqlite3_value_dup()]. +** The [tdsqlite3_value_blob | tdsqlite3_value_type()] family of +** interfaces require protected tdsqlite3_value objects. +*/ +typedef struct tdsqlite3_value tdsqlite3_value; + +/* +** CAPI3REF: SQL Function Context Object +** +** The context in which an SQL function executes is stored in an +** tdsqlite3_context object. ^A pointer to an tdsqlite3_context object +** is always first parameter to [application-defined SQL functions]. +** The application-defined SQL function implementation will pass this +** pointer through into calls to [tdsqlite3_result_int | tdsqlite3_result()], +** [tdsqlite3_aggregate_context()], [tdsqlite3_user_data()], +** [tdsqlite3_context_db_handle()], [tdsqlite3_get_auxdata()], +** and/or [tdsqlite3_set_auxdata()]. +*/ +typedef struct tdsqlite3_context tdsqlite3_context; + +/* +** CAPI3REF: Binding Values To Prepared Statements +** KEYWORDS: {host parameter} {host parameters} {host parameter name} +** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding} +** METHOD: tdsqlite3_stmt +** +** ^(In the SQL statement text input to [tdsqlite3_prepare_v2()] and its variants, +** literals may be replaced by a [parameter] that matches one of following +** templates: +** +**
    +**
  • ? +**
  • ?NNN +**
  • :VVV +**
  • @VVV +**
  • $VVV +**
+** +** In the templates above, NNN represents an integer literal, +** and VVV represents an alphanumeric identifier.)^ ^The values of these +** parameters (also called "host parameter names" or "SQL parameters") +** can be set using the tdsqlite3_bind_*() routines defined here. +** +** ^The first argument to the tdsqlite3_bind_*() routines is always +** a pointer to the [tdsqlite3_stmt] object returned from +** [tdsqlite3_prepare_v2()] or its variants. +** +** ^The second argument is the index of the SQL parameter to be set. +** ^The leftmost SQL parameter has an index of 1. ^When the same named +** SQL parameter is used more than once, second and subsequent +** occurrences have the same index as the first occurrence. +** ^The index for named parameters can be looked up using the +** [tdsqlite3_bind_parameter_index()] API if desired. ^The index +** for "?NNN" parameters is the value of NNN. +** ^The NNN value must be between 1 and the [tdsqlite3_limit()] +** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999). +** +** ^The third argument is the value to bind to the parameter. +** ^If the third parameter to tdsqlite3_bind_text() or tdsqlite3_bind_text16() +** or tdsqlite3_bind_blob() is a NULL pointer then the fourth parameter +** is ignored and the end result is the same as tdsqlite3_bind_null(). +** +** ^(In those routines that have a fourth argument, its value is the +** number of bytes in the parameter. To be clear: the value is the +** number of bytes in the value, not the number of characters.)^ +** ^If the fourth parameter to tdsqlite3_bind_text() or tdsqlite3_bind_text16() +** is negative, then the length of the string is +** the number of bytes up to the first zero terminator. +** If the fourth parameter to tdsqlite3_bind_blob() is negative, then +** the behavior is undefined. +** If a non-negative fourth parameter is provided to tdsqlite3_bind_text() +** or tdsqlite3_bind_text16() or tdsqlite3_bind_text64() then +** that parameter must be the byte offset +** where the NUL terminator would occur assuming the string were NUL +** terminated. If any NUL characters occur at byte offsets less than +** the value of the fourth parameter then the resulting string value will +** contain embedded NULs. The result of expressions involving strings +** with embedded NULs is undefined. +** +** ^The fifth argument to the BLOB and string binding interfaces +** is a destructor used to dispose of the BLOB or +** string after SQLite has finished with it. ^The destructor is called +** to dispose of the BLOB or string even if the call to the bind API fails, +** except the destructor is not called if the third parameter is a NULL +** pointer or the fourth parameter is negative. +** ^If the fifth argument is +** the special value [SQLITE_STATIC], then SQLite assumes that the +** information is in static, unmanaged space and does not need to be freed. +** ^If the fifth argument has the value [SQLITE_TRANSIENT], then +** SQLite makes its own private copy of the data immediately, before +** the tdsqlite3_bind_*() routine returns. +** +** ^The sixth argument to tdsqlite3_bind_text64() must be one of +** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE] +** to specify the encoding of the text in the third parameter. If +** the sixth argument to tdsqlite3_bind_text64() is not one of the +** allowed values shown above, or if the text encoding is different +** from the encoding specified by the sixth parameter, then the behavior +** is undefined. +** +** ^The tdsqlite3_bind_zeroblob() routine binds a BLOB of length N that +** is filled with zeroes. ^A zeroblob uses a fixed amount of memory +** (just an integer to hold its size) while it is being processed. +** Zeroblobs are intended to serve as placeholders for BLOBs whose +** content is later written using +** [tdsqlite3_blob_open | incremental BLOB I/O] routines. +** ^A negative value for the zeroblob results in a zero-length BLOB. +** +** ^The tdsqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in +** [prepared statement] S to have an SQL value of NULL, but to also be +** associated with the pointer P of type T. ^D is either a NULL pointer or +** a pointer to a destructor function for P. ^SQLite will invoke the +** destructor D with a single argument of P when it is finished using +** P. The T parameter should be a static string, preferably a string +** literal. The tdsqlite3_bind_pointer() routine is part of the +** [pointer passing interface] added for SQLite 3.20.0. +** +** ^If any of the tdsqlite3_bind_*() routines are called with a NULL pointer +** for the [prepared statement] or with a prepared statement for which +** [tdsqlite3_step()] has been called more recently than [tdsqlite3_reset()], +** then the call will return [SQLITE_MISUSE]. If any tdsqlite3_bind_() +** routine is passed a [prepared statement] that has been finalized, the +** result is undefined and probably harmful. +** +** ^Bindings are not cleared by the [tdsqlite3_reset()] routine. +** ^Unbound parameters are interpreted as NULL. +** +** ^The tdsqlite3_bind_* routines return [SQLITE_OK] on success or an +** [error code] if anything goes wrong. +** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB +** exceeds limits imposed by [tdsqlite3_limit]([SQLITE_LIMIT_LENGTH]) or +** [SQLITE_MAX_LENGTH]. +** ^[SQLITE_RANGE] is returned if the parameter +** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails. +** +** See also: [tdsqlite3_bind_parameter_count()], +** [tdsqlite3_bind_parameter_name()], and [tdsqlite3_bind_parameter_index()]. +*/ +SQLITE_API int tdsqlite3_bind_blob(tdsqlite3_stmt*, int, const void*, int n, void(*)(void*)); +SQLITE_API int tdsqlite3_bind_blob64(tdsqlite3_stmt*, int, const void*, tdsqlite3_uint64, + void(*)(void*)); +SQLITE_API int tdsqlite3_bind_double(tdsqlite3_stmt*, int, double); +SQLITE_API int tdsqlite3_bind_int(tdsqlite3_stmt*, int, int); +SQLITE_API int tdsqlite3_bind_int64(tdsqlite3_stmt*, int, tdsqlite3_int64); +SQLITE_API int tdsqlite3_bind_null(tdsqlite3_stmt*, int); +SQLITE_API int tdsqlite3_bind_text(tdsqlite3_stmt*,int,const char*,int,void(*)(void*)); +SQLITE_API int tdsqlite3_bind_text16(tdsqlite3_stmt*, int, const void*, int, void(*)(void*)); +SQLITE_API int tdsqlite3_bind_text64(tdsqlite3_stmt*, int, const char*, tdsqlite3_uint64, + void(*)(void*), unsigned char encoding); +SQLITE_API int tdsqlite3_bind_value(tdsqlite3_stmt*, int, const tdsqlite3_value*); +SQLITE_API int tdsqlite3_bind_pointer(tdsqlite3_stmt*, int, void*, const char*,void(*)(void*)); +SQLITE_API int tdsqlite3_bind_zeroblob(tdsqlite3_stmt*, int, int n); +SQLITE_API int tdsqlite3_bind_zeroblob64(tdsqlite3_stmt*, int, tdsqlite3_uint64); + +/* +** CAPI3REF: Number Of SQL Parameters +** METHOD: tdsqlite3_stmt +** +** ^This routine can be used to find the number of [SQL parameters] +** in a [prepared statement]. SQL parameters are tokens of the +** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as +** placeholders for values that are [tdsqlite3_bind_blob | bound] +** to the parameters at a later time. +** +** ^(This routine actually returns the index of the largest (rightmost) +** parameter. For all forms except ?NNN, this will correspond to the +** number of unique parameters. If parameters of the ?NNN form are used, +** there may be gaps in the list.)^ +** +** See also: [tdsqlite3_bind_blob|tdsqlite3_bind()], +** [tdsqlite3_bind_parameter_name()], and +** [tdsqlite3_bind_parameter_index()]. +*/ +SQLITE_API int tdsqlite3_bind_parameter_count(tdsqlite3_stmt*); + +/* +** CAPI3REF: Name Of A Host Parameter +** METHOD: tdsqlite3_stmt +** +** ^The tdsqlite3_bind_parameter_name(P,N) interface returns +** the name of the N-th [SQL parameter] in the [prepared statement] P. +** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" +** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" +** respectively. +** In other words, the initial ":" or "$" or "@" or "?" +** is included as part of the name.)^ +** ^Parameters of the form "?" without a following integer have no name +** and are referred to as "nameless" or "anonymous parameters". +** +** ^The first host parameter has an index of 1, not 0. +** +** ^If the value N is out of range or if the N-th parameter is +** nameless, then NULL is returned. ^The returned string is +** always in UTF-8 encoding even if the named parameter was +** originally specified as UTF-16 in [tdsqlite3_prepare16()], +** [tdsqlite3_prepare16_v2()], or [tdsqlite3_prepare16_v3()]. +** +** See also: [tdsqlite3_bind_blob|tdsqlite3_bind()], +** [tdsqlite3_bind_parameter_count()], and +** [tdsqlite3_bind_parameter_index()]. +*/ +SQLITE_API const char *tdsqlite3_bind_parameter_name(tdsqlite3_stmt*, int); + +/* +** CAPI3REF: Index Of A Parameter With A Given Name +** METHOD: tdsqlite3_stmt +** +** ^Return the index of an SQL parameter given its name. ^The +** index value returned is suitable for use as the second +** parameter to [tdsqlite3_bind_blob|tdsqlite3_bind()]. ^A zero +** is returned if no matching parameter is found. ^The parameter +** name must be given in UTF-8 even if the original statement +** was prepared from UTF-16 text using [tdsqlite3_prepare16_v2()] or +** [tdsqlite3_prepare16_v3()]. +** +** See also: [tdsqlite3_bind_blob|tdsqlite3_bind()], +** [tdsqlite3_bind_parameter_count()], and +** [tdsqlite3_bind_parameter_name()]. +*/ +SQLITE_API int tdsqlite3_bind_parameter_index(tdsqlite3_stmt*, const char *zName); + +/* +** CAPI3REF: Reset All Bindings On A Prepared Statement +** METHOD: tdsqlite3_stmt +** +** ^Contrary to the intuition of many, [tdsqlite3_reset()] does not reset +** the [tdsqlite3_bind_blob | bindings] on a [prepared statement]. +** ^Use this routine to reset all host parameters to NULL. +*/ +SQLITE_API int tdsqlite3_clear_bindings(tdsqlite3_stmt*); + +/* +** CAPI3REF: Number Of Columns In A Result Set +** METHOD: tdsqlite3_stmt +** +** ^Return the number of columns in the result set returned by the +** [prepared statement]. ^If this routine returns 0, that means the +** [prepared statement] returns no data (for example an [UPDATE]). +** ^However, just because this routine returns a positive number does not +** mean that one or more rows of data will be returned. ^A SELECT statement +** will always have a positive tdsqlite3_column_count() but depending on the +** WHERE clause constraints and the table content, it might return no rows. +** +** See also: [tdsqlite3_data_count()] +*/ +SQLITE_API int tdsqlite3_column_count(tdsqlite3_stmt *pStmt); + +/* +** CAPI3REF: Column Names In A Result Set +** METHOD: tdsqlite3_stmt +** +** ^These routines return the name assigned to a particular column +** in the result set of a [SELECT] statement. ^The tdsqlite3_column_name() +** interface returns a pointer to a zero-terminated UTF-8 string +** and tdsqlite3_column_name16() returns a pointer to a zero-terminated +** UTF-16 string. ^The first parameter is the [prepared statement] +** that implements the [SELECT] statement. ^The second parameter is the +** column number. ^The leftmost column is number 0. +** +** ^The returned string pointer is valid until either the [prepared statement] +** is destroyed by [tdsqlite3_finalize()] or until the statement is automatically +** reprepared by the first call to [tdsqlite3_step()] for a particular run +** or until the next call to +** tdsqlite3_column_name() or tdsqlite3_column_name16() on the same column. +** +** ^If tdsqlite3_malloc() fails during the processing of either routine +** (for example during a conversion from UTF-8 to UTF-16) then a +** NULL pointer is returned. +** +** ^The name of a result column is the value of the "AS" clause for +** that column, if there is an AS clause. If there is no AS clause +** then the name of the column is unspecified and may change from +** one release of SQLite to the next. +*/ +SQLITE_API const char *tdsqlite3_column_name(tdsqlite3_stmt*, int N); +SQLITE_API const void *tdsqlite3_column_name16(tdsqlite3_stmt*, int N); + +/* +** CAPI3REF: Source Of Data In A Query Result +** METHOD: tdsqlite3_stmt +** +** ^These routines provide a means to determine the database, table, and +** table column that is the origin of a particular result column in +** [SELECT] statement. +** ^The name of the database or table or column can be returned as +** either a UTF-8 or UTF-16 string. ^The _database_ routines return +** the database name, the _table_ routines return the table name, and +** the origin_ routines return the column name. +** ^The returned string is valid until the [prepared statement] is destroyed +** using [tdsqlite3_finalize()] or until the statement is automatically +** reprepared by the first call to [tdsqlite3_step()] for a particular run +** or until the same information is requested +** again in a different encoding. +** +** ^The names returned are the original un-aliased names of the +** database, table, and column. +** +** ^The first argument to these interfaces is a [prepared statement]. +** ^These functions return information about the Nth result column returned by +** the statement, where N is the second function argument. +** ^The left-most column is column 0 for these routines. +** +** ^If the Nth column returned by the statement is an expression or +** subquery and is not a column value, then all of these functions return +** NULL. ^These routines might also return NULL if a memory allocation error +** occurs. ^Otherwise, they return the name of the attached database, table, +** or column that query result column was extracted from. +** +** ^As with all other SQLite APIs, those whose names end with "16" return +** UTF-16 encoded strings and the other functions return UTF-8. +** +** ^These APIs are only available if the library was compiled with the +** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol. +** +** If two or more threads call one or more +** [tdsqlite3_column_database_name | column metadata interfaces] +** for the same [prepared statement] and result column +** at the same time then the results are undefined. +*/ +SQLITE_API const char *tdsqlite3_column_database_name(tdsqlite3_stmt*,int); +SQLITE_API const void *tdsqlite3_column_database_name16(tdsqlite3_stmt*,int); +SQLITE_API const char *tdsqlite3_column_table_name(tdsqlite3_stmt*,int); +SQLITE_API const void *tdsqlite3_column_table_name16(tdsqlite3_stmt*,int); +SQLITE_API const char *tdsqlite3_column_origin_name(tdsqlite3_stmt*,int); +SQLITE_API const void *tdsqlite3_column_origin_name16(tdsqlite3_stmt*,int); + +/* +** CAPI3REF: Declared Datatype Of A Query Result +** METHOD: tdsqlite3_stmt +** +** ^(The first parameter is a [prepared statement]. +** If this statement is a [SELECT] statement and the Nth column of the +** returned result set of that [SELECT] is a table column (not an +** expression or subquery) then the declared type of the table +** column is returned.)^ ^If the Nth column of the result set is an +** expression or subquery, then a NULL pointer is returned. +** ^The returned string is always UTF-8 encoded. +** +** ^(For example, given the database schema: +** +** CREATE TABLE t1(c1 VARIANT); +** +** and the following statement to be compiled: +** +** SELECT c1 + 1, c1 FROM t1; +** +** this routine would return the string "VARIANT" for the second result +** column (i==1), and a NULL pointer for the first result column (i==0).)^ +** +** ^SQLite uses dynamic run-time typing. ^So just because a column +** is declared to contain a particular type does not mean that the +** data stored in that column is of the declared type. SQLite is +** strongly typed, but the typing is dynamic not static. ^Type +** is associated with individual values, not with the containers +** used to hold those values. +*/ +SQLITE_API const char *tdsqlite3_column_decltype(tdsqlite3_stmt*,int); +SQLITE_API const void *tdsqlite3_column_decltype16(tdsqlite3_stmt*,int); + +/* +** CAPI3REF: Evaluate An SQL Statement +** METHOD: tdsqlite3_stmt +** +** After a [prepared statement] has been prepared using any of +** [tdsqlite3_prepare_v2()], [tdsqlite3_prepare_v3()], [tdsqlite3_prepare16_v2()], +** or [tdsqlite3_prepare16_v3()] or one of the legacy +** interfaces [tdsqlite3_prepare()] or [tdsqlite3_prepare16()], this function +** must be called one or more times to evaluate the statement. +** +** The details of the behavior of the tdsqlite3_step() interface depend +** on whether the statement was prepared using the newer "vX" interfaces +** [tdsqlite3_prepare_v3()], [tdsqlite3_prepare_v2()], [tdsqlite3_prepare16_v3()], +** [tdsqlite3_prepare16_v2()] or the older legacy +** interfaces [tdsqlite3_prepare()] and [tdsqlite3_prepare16()]. The use of the +** new "vX" interface is recommended for new applications but the legacy +** interface will continue to be supported. +** +** ^In the legacy interface, the return value will be either [SQLITE_BUSY], +** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE]. +** ^With the "v2" interface, any of the other [result codes] or +** [extended result codes] might be returned as well. +** +** ^[SQLITE_BUSY] means that the database engine was unable to acquire the +** database locks it needs to do its job. ^If the statement is a [COMMIT] +** or occurs outside of an explicit transaction, then you can retry the +** statement. If the statement is not a [COMMIT] and occurs within an +** explicit transaction then you should rollback the transaction before +** continuing. +** +** ^[SQLITE_DONE] means that the statement has finished executing +** successfully. tdsqlite3_step() should not be called again on this virtual +** machine without first calling [tdsqlite3_reset()] to reset the virtual +** machine back to its initial state. +** +** ^If the SQL statement being executed returns any data, then [SQLITE_ROW] +** is returned each time a new row of data is ready for processing by the +** caller. The values may be accessed using the [column access functions]. +** tdsqlite3_step() is called again to retrieve the next row of data. +** +** ^[SQLITE_ERROR] means that a run-time error (such as a constraint +** violation) has occurred. tdsqlite3_step() should not be called again on +** the VM. More information may be found by calling [tdsqlite3_errmsg()]. +** ^With the legacy interface, a more specific error code (for example, +** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth) +** can be obtained by calling [tdsqlite3_reset()] on the +** [prepared statement]. ^In the "v2" interface, +** the more specific error code is returned directly by tdsqlite3_step(). +** +** [SQLITE_MISUSE] means that the this routine was called inappropriately. +** Perhaps it was called on a [prepared statement] that has +** already been [tdsqlite3_finalize | finalized] or on one that had +** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could +** be the case that the same database connection is being used by two or +** more threads at the same moment in time. +** +** For all versions of SQLite up to and including 3.6.23.1, a call to +** [tdsqlite3_reset()] was required after tdsqlite3_step() returned anything +** other than [SQLITE_ROW] before any subsequent invocation of +** tdsqlite3_step(). Failure to reset the prepared statement using +** [tdsqlite3_reset()] would result in an [SQLITE_MISUSE] return from +** tdsqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1], +** tdsqlite3_step() began +** calling [tdsqlite3_reset()] automatically in this circumstance rather +** than returning [SQLITE_MISUSE]. This is not considered a compatibility +** break because any application that ever receives an SQLITE_MISUSE error +** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option +** can be used to restore the legacy behavior. +** +** Goofy Interface Alert: In the legacy interface, the tdsqlite3_step() +** API always returns a generic error code, [SQLITE_ERROR], following any +** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call +** [tdsqlite3_reset()] or [tdsqlite3_finalize()] in order to find one of the +** specific [error codes] that better describes the error. +** We admit that this is a goofy design. The problem has been fixed +** with the "v2" interface. If you prepare all of your SQL statements +** using [tdsqlite3_prepare_v3()] or [tdsqlite3_prepare_v2()] +** or [tdsqlite3_prepare16_v2()] or [tdsqlite3_prepare16_v3()] instead +** of the legacy [tdsqlite3_prepare()] and [tdsqlite3_prepare16()] interfaces, +** then the more specific [error codes] are returned directly +** by tdsqlite3_step(). The use of the "vX" interfaces is recommended. +*/ +SQLITE_API int tdsqlite3_step(tdsqlite3_stmt*); + +/* +** CAPI3REF: Number of columns in a result set +** METHOD: tdsqlite3_stmt +** +** ^The tdsqlite3_data_count(P) interface returns the number of columns in the +** current row of the result set of [prepared statement] P. +** ^If prepared statement P does not have results ready to return +** (via calls to the [tdsqlite3_column_int | tdsqlite3_column()] family of +** interfaces) then tdsqlite3_data_count(P) returns 0. +** ^The tdsqlite3_data_count(P) routine also returns 0 if P is a NULL pointer. +** ^The tdsqlite3_data_count(P) routine returns 0 if the previous call to +** [tdsqlite3_step](P) returned [SQLITE_DONE]. ^The tdsqlite3_data_count(P) +** will return non-zero if previous call to [tdsqlite3_step](P) returned +** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum] +** where it always returns zero since each step of that multi-step +** pragma returns 0 columns of data. +** +** See also: [tdsqlite3_column_count()] +*/ +SQLITE_API int tdsqlite3_data_count(tdsqlite3_stmt *pStmt); + +/* +** CAPI3REF: Fundamental Datatypes +** KEYWORDS: SQLITE_TEXT +** +** ^(Every value in SQLite has one of five fundamental datatypes: +** +**
    +**
  • 64-bit signed integer +**
  • 64-bit IEEE floating point number +**
  • string +**
  • BLOB +**
  • NULL +**
)^ +** +** These constants are codes for each of those types. +** +** Note that the SQLITE_TEXT constant was also used in SQLite version 2 +** for a completely different meaning. Software that links against both +** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not +** SQLITE_TEXT. +*/ +#define SQLITE_INTEGER 1 +#define SQLITE_FLOAT 2 +#define SQLITE_BLOB 4 +#define SQLITE_NULL 5 +#ifdef SQLITE_TEXT +# undef SQLITE_TEXT +#else +# define SQLITE_TEXT 3 +#endif +#define SQLITE3_TEXT 3 + +/* +** CAPI3REF: Result Values From A Query +** KEYWORDS: {column access functions} +** METHOD: tdsqlite3_stmt +** +** Summary: +**
+**
tdsqlite3_column_blob→BLOB result +**
tdsqlite3_column_double→REAL result +**
tdsqlite3_column_int→32-bit INTEGER result +**
tdsqlite3_column_int64→64-bit INTEGER result +**
tdsqlite3_column_text→UTF-8 TEXT result +**
tdsqlite3_column_text16→UTF-16 TEXT result +**
tdsqlite3_column_value→The result as an +** [tdsqlite3_value|unprotected tdsqlite3_value] object. +**
    +**
tdsqlite3_column_bytes→Size of a BLOB +** or a UTF-8 TEXT result in bytes +**
tdsqlite3_column_bytes16   +** →  Size of UTF-16 +** TEXT in bytes +**
tdsqlite3_column_type→Default +** datatype of the result +**
+** +** Details: +** +** ^These routines return information about a single column of the current +** result row of a query. ^In every case the first argument is a pointer +** to the [prepared statement] that is being evaluated (the [tdsqlite3_stmt*] +** that was returned from [tdsqlite3_prepare_v2()] or one of its variants) +** and the second argument is the index of the column for which information +** should be returned. ^The leftmost column of the result set has the index 0. +** ^The number of columns in the result can be determined using +** [tdsqlite3_column_count()]. +** +** If the SQL statement does not currently point to a valid row, or if the +** column index is out of range, the result is undefined. +** These routines may only be called when the most recent call to +** [tdsqlite3_step()] has returned [SQLITE_ROW] and neither +** [tdsqlite3_reset()] nor [tdsqlite3_finalize()] have been called subsequently. +** If any of these routines are called after [tdsqlite3_reset()] or +** [tdsqlite3_finalize()] or after [tdsqlite3_step()] has returned +** something other than [SQLITE_ROW], the results are undefined. +** If [tdsqlite3_step()] or [tdsqlite3_reset()] or [tdsqlite3_finalize()] +** are called from a different thread while any of these routines +** are pending, then the results are undefined. +** +** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16) +** each return the value of a result column in a specific data format. If +** the result column is not initially in the requested format (for example, +** if the query returns an integer but the tdsqlite3_column_text() interface +** is used to extract the value) then an automatic type conversion is performed. +** +** ^The tdsqlite3_column_type() routine returns the +** [SQLITE_INTEGER | datatype code] for the initial data type +** of the result column. ^The returned value is one of [SQLITE_INTEGER], +** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL]. +** The return value of tdsqlite3_column_type() can be used to decide which +** of the first six interface should be used to extract the column value. +** The value returned by tdsqlite3_column_type() is only meaningful if no +** automatic type conversions have occurred for the value in question. +** After a type conversion, the result of calling tdsqlite3_column_type() +** is undefined, though harmless. Future +** versions of SQLite may change the behavior of tdsqlite3_column_type() +** following a type conversion. +** +** If the result is a BLOB or a TEXT string, then the tdsqlite3_column_bytes() +** or tdsqlite3_column_bytes16() interfaces can be used to determine the size +** of that BLOB or string. +** +** ^If the result is a BLOB or UTF-8 string then the tdsqlite3_column_bytes() +** routine returns the number of bytes in that BLOB or string. +** ^If the result is a UTF-16 string, then tdsqlite3_column_bytes() converts +** the string to UTF-8 and then returns the number of bytes. +** ^If the result is a numeric value then tdsqlite3_column_bytes() uses +** [tdsqlite3_snprintf()] to convert that value to a UTF-8 string and returns +** the number of bytes in that string. +** ^If the result is NULL, then tdsqlite3_column_bytes() returns zero. +** +** ^If the result is a BLOB or UTF-16 string then the tdsqlite3_column_bytes16() +** routine returns the number of bytes in that BLOB or string. +** ^If the result is a UTF-8 string, then tdsqlite3_column_bytes16() converts +** the string to UTF-16 and then returns the number of bytes. +** ^If the result is a numeric value then tdsqlite3_column_bytes16() uses +** [tdsqlite3_snprintf()] to convert that value to a UTF-16 string and returns +** the number of bytes in that string. +** ^If the result is NULL, then tdsqlite3_column_bytes16() returns zero. +** +** ^The values returned by [tdsqlite3_column_bytes()] and +** [tdsqlite3_column_bytes16()] do not include the zero terminators at the end +** of the string. ^For clarity: the values returned by +** [tdsqlite3_column_bytes()] and [tdsqlite3_column_bytes16()] are the number of +** bytes in the string, not the number of characters. +** +** ^Strings returned by tdsqlite3_column_text() and tdsqlite3_column_text16(), +** even empty strings, are always zero-terminated. ^The return +** value from tdsqlite3_column_blob() for a zero-length BLOB is a NULL pointer. +** +** Warning: ^The object returned by [tdsqlite3_column_value()] is an +** [unprotected tdsqlite3_value] object. In a multithreaded environment, +** an unprotected tdsqlite3_value object may only be used safely with +** [tdsqlite3_bind_value()] and [tdsqlite3_result_value()]. +** If the [unprotected tdsqlite3_value] object returned by +** [tdsqlite3_column_value()] is used in any other way, including calls +** to routines like [tdsqlite3_value_int()], [tdsqlite3_value_text()], +** or [tdsqlite3_value_bytes()], the behavior is not threadsafe. +** Hence, the tdsqlite3_column_value() interface +** is normally only useful within the implementation of +** [application-defined SQL functions] or [virtual tables], not within +** top-level application code. +** +** The these routines may attempt to convert the datatype of the result. +** ^For example, if the internal representation is FLOAT and a text result +** is requested, [tdsqlite3_snprintf()] is used internally to perform the +** conversion automatically. ^(The following table details the conversions +** that are applied: +** +**
+** +**
Internal
Type 		Requested
Type 		Conversion +** +**
NULL INTEGER Result is 0 +**
NULL FLOAT Result is 0.0 +**
NULL TEXT Result is a NULL pointer +**
NULL BLOB Result is a NULL pointer +**
INTEGER FLOAT Convert from integer to float +**
INTEGER TEXT ASCII rendering of the integer +**
INTEGER BLOB Same as INTEGER->TEXT +**
FLOAT INTEGER [CAST] to INTEGER +**
FLOAT TEXT ASCII rendering of the float +**
FLOAT BLOB [CAST] to BLOB +**
TEXT INTEGER [CAST] to INTEGER +**
TEXT FLOAT [CAST] to REAL +**
TEXT BLOB No change +**
BLOB INTEGER [CAST] to INTEGER +**
BLOB FLOAT [CAST] to REAL +**
BLOB TEXT Add a zero terminator if needed +**
+**
)^ +** +** Note that when type conversions occur, pointers returned by prior +** calls to tdsqlite3_column_blob(), tdsqlite3_column_text(), and/or +** tdsqlite3_column_text16() may be invalidated. +** Type conversions and pointer invalidations might occur +** in the following cases: +** +**
    +**
  • The initial content is a BLOB and tdsqlite3_column_text() or +** tdsqlite3_column_text16() is called. A zero-terminator might +** need to be added to the string.
    • +**
  • The initial content is UTF-8 text and tdsqlite3_column_bytes16() or +** tdsqlite3_column_text16() is called. The content must be converted +** to UTF-16.
    • +**
  • The initial content is UTF-16 text and tdsqlite3_column_bytes() or +** tdsqlite3_column_text() is called. The content must be converted +** to UTF-8.
    • +**
+** +** ^Conversions between UTF-16be and UTF-16le are always done in place and do +** not invalidate a prior pointer, though of course the content of the buffer +** that the prior pointer references will have been modified. Other kinds +** of conversion are done in place when it is possible, but sometimes they +** are not possible and in those cases prior pointers are invalidated. +** +** The safest policy is to invoke these routines +** in one of the following ways: +** +**
    +**
  • tdsqlite3_column_text() followed by tdsqlite3_column_bytes()
    • +**
  • tdsqlite3_column_blob() followed by tdsqlite3_column_bytes()
    • +**
  • tdsqlite3_column_text16() followed by tdsqlite3_column_bytes16()
    • +**
+** +** In other words, you should call tdsqlite3_column_text(), +** tdsqlite3_column_blob(), or tdsqlite3_column_text16() first to force the result +** into the desired format, then invoke tdsqlite3_column_bytes() or +** tdsqlite3_column_bytes16() to find the size of the result. Do not mix calls +** to tdsqlite3_column_text() or tdsqlite3_column_blob() with calls to +** tdsqlite3_column_bytes16(), and do not mix calls to tdsqlite3_column_text16() +** with calls to tdsqlite3_column_bytes(). +** +** ^The pointers returned are valid until a type conversion occurs as +** described above, or until [tdsqlite3_step()] or [tdsqlite3_reset()] or +** [tdsqlite3_finalize()] is called. ^The memory space used to hold strings +** and BLOBs is freed automatically. Do not pass the pointers returned +** from [tdsqlite3_column_blob()], [tdsqlite3_column_text()], etc. into +** [tdsqlite3_free()]. +** +** As long as the input parameters are correct, these routines will only +** fail if an out-of-memory error occurs during a format conversion. +** Only the following subset of interfaces are subject to out-of-memory +** errors: +** +**
    +**
  • tdsqlite3_column_blob() +**
  • tdsqlite3_column_text() +**
  • tdsqlite3_column_text16() +**
  • tdsqlite3_column_bytes() +**
  • tdsqlite3_column_bytes16() +**
+** +** If an out-of-memory error occurs, then the return value from these +** routines is the same as if the column had contained an SQL NULL value. +** Valid SQL NULL returns can be distinguished from out-of-memory errors +** by invoking the [tdsqlite3_errcode()] immediately after the suspect +** return value is obtained and before any +** other SQLite interface is called on the same [database connection]. +*/ +SQLITE_API const void *tdsqlite3_column_blob(tdsqlite3_stmt*, int iCol); +SQLITE_API double tdsqlite3_column_double(tdsqlite3_stmt*, int iCol); +SQLITE_API int tdsqlite3_column_int(tdsqlite3_stmt*, int iCol); +SQLITE_API tdsqlite3_int64 tdsqlite3_column_int64(tdsqlite3_stmt*, int iCol); +SQLITE_API const unsigned char *tdsqlite3_column_text(tdsqlite3_stmt*, int iCol); +SQLITE_API const void *tdsqlite3_column_text16(tdsqlite3_stmt*, int iCol); +SQLITE_API tdsqlite3_value *tdsqlite3_column_value(tdsqlite3_stmt*, int iCol); +SQLITE_API int tdsqlite3_column_bytes(tdsqlite3_stmt*, int iCol); +SQLITE_API int tdsqlite3_column_bytes16(tdsqlite3_stmt*, int iCol); +SQLITE_API int tdsqlite3_column_type(tdsqlite3_stmt*, int iCol); + +/* +** CAPI3REF: Destroy A Prepared Statement Object +** DESTRUCTOR: tdsqlite3_stmt +** +** ^The tdsqlite3_finalize() function is called to delete a [prepared statement]. +** ^If the most recent evaluation of the statement encountered no errors +** or if the statement is never been evaluated, then tdsqlite3_finalize() returns +** SQLITE_OK. ^If the most recent evaluation of statement S failed, then +** tdsqlite3_finalize(S) returns the appropriate [error code] or +** [extended error code]. +** +** ^The tdsqlite3_finalize(S) routine can be called at any point during +** the life cycle of [prepared statement] S: +** before statement S is ever evaluated, after +** one or more calls to [tdsqlite3_reset()], or after any call +** to [tdsqlite3_step()] regardless of whether or not the statement has +** completed execution. +** +** ^Invoking tdsqlite3_finalize() on a NULL pointer is a harmless no-op. +** +** The application must finalize every [prepared statement] in order to avoid +** resource leaks. It is a grievous error for the application to try to use +** a prepared statement after it has been finalized. Any use of a prepared +** statement after it has been finalized can result in undefined and +** undesirable behavior such as segfaults and heap corruption. +*/ +SQLITE_API int tdsqlite3_finalize(tdsqlite3_stmt *pStmt); + +/* +** CAPI3REF: Reset A Prepared Statement Object +** METHOD: tdsqlite3_stmt +** +** The tdsqlite3_reset() function is called to reset a [prepared statement] +** object back to its initial state, ready to be re-executed. +** ^Any SQL statement variables that had values bound to them using +** the [tdsqlite3_bind_blob | tdsqlite3_bind_*() API] retain their values. +** Use [tdsqlite3_clear_bindings()] to reset the bindings. +** +** ^The [tdsqlite3_reset(S)] interface resets the [prepared statement] S +** back to the beginning of its program. +** +** ^If the most recent call to [tdsqlite3_step(S)] for the +** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE], +** or if [tdsqlite3_step(S)] has never before been called on S, +** then [tdsqlite3_reset(S)] returns [SQLITE_OK]. +** +** ^If the most recent call to [tdsqlite3_step(S)] for the +** [prepared statement] S indicated an error, then +** [tdsqlite3_reset(S)] returns an appropriate [error code]. +** +** ^The [tdsqlite3_reset(S)] interface does not change the values +** of any [tdsqlite3_bind_blob|bindings] on the [prepared statement] S. +*/ +SQLITE_API int tdsqlite3_reset(tdsqlite3_stmt *pStmt); + +/* +** CAPI3REF: Create Or Redefine SQL Functions +** KEYWORDS: {function creation routines} +** METHOD: tdsqlite3 +** +** ^These functions (collectively known as "function creation routines") +** are used to add SQL functions or aggregates or to redefine the behavior +** of existing SQL functions or aggregates. The only differences between +** the three "tdsqlite3_create_function*" routines are the text encoding +** expected for the second parameter (the name of the function being +** created) and the presence or absence of a destructor callback for +** the application data pointer. Function tdsqlite3_create_window_function() +** is similar, but allows the user to supply the extra callback functions +** needed by [aggregate window functions]. +** +** ^The first parameter is the [database connection] to which the SQL +** function is to be added. ^If an application uses more than one database +** connection then application-defined SQL functions must be added +** to each database connection separately. +** +** ^The second parameter is the name of the SQL function to be created or +** redefined. ^The length of the name is limited to 255 bytes in a UTF-8 +** representation, exclusive of the zero-terminator. ^Note that the name +** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes. +** ^Any attempt to create a function with a longer name +** will result in [SQLITE_MISUSE] being returned. +** +** ^The third parameter (nArg) +** is the number of arguments that the SQL function or +** aggregate takes. ^If this parameter is -1, then the SQL function or +** aggregate may take any number of arguments between 0 and the limit +** set by [tdsqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third +** parameter is less than -1 or greater than 127 then the behavior is +** undefined. +** +** ^The fourth parameter, eTextRep, specifies what +** [SQLITE_UTF8 | text encoding] this SQL function prefers for +** its parameters. The application should set this parameter to +** [SQLITE_UTF16LE] if the function implementation invokes +** [tdsqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the +** implementation invokes [tdsqlite3_value_text16be()] on an input, or +** [SQLITE_UTF16] if [tdsqlite3_value_text16()] is used, or [SQLITE_UTF8] +** otherwise. ^The same SQL function may be registered multiple times using +** different preferred text encodings, with different implementations for +** each encoding. +** ^When multiple implementations of the same function are available, SQLite +** will pick the one that involves the least amount of data conversion. +** +** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC] +** to signal that the function will always return the same result given +** the same inputs within a single SQL statement. Most SQL functions are +** deterministic. The built-in [random()] SQL function is an example of a +** function that is not deterministic. The SQLite query planner is able to +** perform additional optimizations on deterministic functions, so use +** of the [SQLITE_DETERMINISTIC] flag is recommended where possible. +** +** ^The fourth parameter may also optionally include the [SQLITE_DIRECTONLY] +** flag, which if present prevents the function from being invoked from +** within VIEWs, TRIGGERs, CHECK constraints, generated column expressions, +** index expressions, or the WHERE clause of partial indexes. +** +** +** For best security, the [SQLITE_DIRECTONLY] flag is recommended for +** all application-defined SQL functions that do not need to be +** used inside of triggers, view, CHECK constraints, or other elements of +** the database schema. This flags is especially recommended for SQL +** functions that have side effects or reveal internal application state. +** Without this flag, an attacker might be able to modify the schema of +** a database file to include invocations of the function with parameters +** chosen by the attacker, which the application will then execute when +** the database file is opened and read. +** +** +** ^(The fifth parameter is an arbitrary pointer. The implementation of the +** function can gain access to this pointer using [tdsqlite3_user_data()].)^ +** +** ^The sixth, seventh and eighth parameters passed to the three +** "tdsqlite3_create_function*" functions, xFunc, xStep and xFinal, are +** pointers to C-language functions that implement the SQL function or +** aggregate. ^A scalar SQL function requires an implementation of the xFunc +** callback only; NULL pointers must be passed as the xStep and xFinal +** parameters. ^An aggregate SQL function requires an implementation of xStep +** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing +** SQL function or aggregate, pass NULL pointers for all three function +** callbacks. +** +** ^The sixth, seventh, eighth and ninth parameters (xStep, xFinal, xValue +** and xInverse) passed to tdsqlite3_create_window_function are pointers to +** C-language callbacks that implement the new function. xStep and xFinal +** must both be non-NULL. xValue and xInverse may either both be NULL, in +** which case a regular aggregate function is created, or must both be +** non-NULL, in which case the new function may be used as either an aggregate +** or aggregate window function. More details regarding the implementation +** of aggregate window functions are +** [user-defined window functions|available here]. +** +** ^(If the final parameter to tdsqlite3_create_function_v2() or +** tdsqlite3_create_window_function() is not NULL, then it is destructor for +** the application data pointer. The destructor is invoked when the function +** is deleted, either by being overloaded or when the database connection +** closes.)^ ^The destructor is also invoked if the call to +** tdsqlite3_create_function_v2() fails. ^When the destructor callback is +** invoked, it is passed a single argument which is a copy of the application +** data pointer which was the fifth parameter to tdsqlite3_create_function_v2(). +** +** ^It is permitted to register multiple implementations of the same +** functions with the same name but with either differing numbers of +** arguments or differing preferred text encodings. ^SQLite will use +** the implementation that most closely matches the way in which the +** SQL function is used. ^A function implementation with a non-negative +** nArg parameter is a better match than a function implementation with +** a negative nArg. ^A function where the preferred text encoding +** matches the database encoding is a better +** match than a function where the encoding is different. +** ^A function where the encoding difference is between UTF16le and UTF16be +** is a closer match than a function where the encoding difference is +** between UTF8 and UTF16. +** +** ^Built-in functions may be overloaded by new application-defined functions. +** +** ^An application-defined function is permitted to call other +** SQLite interfaces. However, such calls must not +** close the database connection nor finalize or reset the prepared +** statement in which the function is running. +*/ +SQLITE_API int tdsqlite3_create_function( + tdsqlite3 *db, + const char *zFunctionName, + int nArg, + int eTextRep, + void *pApp, + void (*xFunc)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xStep)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xFinal)(tdsqlite3_context*) +); +SQLITE_API int tdsqlite3_create_function16( + tdsqlite3 *db, + const void *zFunctionName, + int nArg, + int eTextRep, + void *pApp, + void (*xFunc)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xStep)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xFinal)(tdsqlite3_context*) +); +SQLITE_API int tdsqlite3_create_function_v2( + tdsqlite3 *db, + const char *zFunctionName, + int nArg, + int eTextRep, + void *pApp, + void (*xFunc)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xStep)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xFinal)(tdsqlite3_context*), + void(*xDestroy)(void*) +); +SQLITE_API int tdsqlite3_create_window_function( + tdsqlite3 *db, + const char *zFunctionName, + int nArg, + int eTextRep, + void *pApp, + void (*xStep)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xFinal)(tdsqlite3_context*), + void (*xValue)(tdsqlite3_context*), + void (*xInverse)(tdsqlite3_context*,int,tdsqlite3_value**), + void(*xDestroy)(void*) +); + +/* +** CAPI3REF: Text Encodings +** +** These constant define integer codes that represent the various +** text encodings supported by SQLite. +*/ +#define SQLITE_UTF8 1 /* IMP: R-37514-35566 */ +#define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */ +#define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */ +#define SQLITE_UTF16 4 /* Use native byte order */ +#define SQLITE_ANY 5 /* Deprecated */ +#define SQLITE_UTF16_ALIGNED 8 /* tdsqlite3_create_collation only */ + +/* +** CAPI3REF: Function Flags +** +** These constants may be ORed together with the +** [SQLITE_UTF8 | preferred text encoding] as the fourth argument +** to [tdsqlite3_create_function()], [tdsqlite3_create_function16()], or +** [tdsqlite3_create_function_v2()]. +** +**
+** [[SQLITE_DETERMINISTIC]]
SQLITE_DETERMINISTIC
+** The SQLITE_DETERMINISTIC flag means that the new function always gives +** the same output when the input parameters are the same. +** The [abs|abs() function] is deterministic, for example, but +** [randomblob|randomblob()] is not. Functions must +** be deterministic in order to be used in certain contexts such as +** with the WHERE clause of [partial indexes] or in [generated columns]. +** SQLite might also optimize deterministic functions by factoring them +** out of inner loops. +**
+** +** [[SQLITE_DIRECTONLY]]
SQLITE_DIRECTONLY
+** The SQLITE_DIRECTONLY flag means that the function may only be invoked +** from top-level SQL, and cannot be used in VIEWs or TRIGGERs nor in +** schema structures such as [CHECK constraints], [DEFAULT clauses], +** [expression indexes], [partial indexes], or [generated columns]. +** The SQLITE_DIRECTONLY flags is a security feature which is recommended +** for all [application-defined SQL functions], and especially for functions +** that have side-effects or that could potentially leak sensitive +** information. +**
+** +** [[SQLITE_INNOCUOUS]]
SQLITE_INNOCUOUS
+** The SQLITE_INNOCUOUS flag means that the function is unlikely +** to cause problems even if misused. An innocuous function should have +** no side effects and should not depend on any values other than its +** input parameters. The [abs|abs() function] is an example of an +** innocuous function. +** The [load_extension() SQL function] is not innocuous because of its +** side effects. +**

SQLITE_INNOCUOUS is similar to SQLITE_DETERMINISTIC, but is not +** exactly the same. The [random|random() function] is an example of a +** function that is innocuous but not deterministic. +**

Some heightened security settings +** ([SQLITE_DBCONFIG_TRUSTED_SCHEMA] and [PRAGMA trusted_schema=OFF]) +** disable the use of SQL functions inside views and triggers and in +** schema structures such as [CHECK constraints], [DEFAULT clauses], +** [expression indexes], [partial indexes], and [generated columns] unless +** the function is tagged with SQLITE_INNOCUOUS. Most built-in functions +** are innocuous. Developers are advised to avoid using the +** SQLITE_INNOCUOUS flag for application-defined functions unless the +** function has been carefully audited and found to be free of potentially +** security-adverse side-effects and information-leaks. +**

+** +** [[SQLITE_SUBTYPE]]
SQLITE_SUBTYPE
+** The SQLITE_SUBTYPE flag indicates to SQLite that a function may call +** [tdsqlite3_value_subtype()] to inspect the sub-types of its arguments. +** Specifying this flag makes no difference for scalar or aggregate user +** functions. However, if it is not specified for a user-defined window +** function, then any sub-types belonging to arguments passed to the window +** function may be discarded before the window function is called (i.e. +** tdsqlite3_value_subtype() will always return 0). +**
+**
+*/ +#define SQLITE_DETERMINISTIC 0x000000800 +#define SQLITE_DIRECTONLY 0x000080000 +#define SQLITE_SUBTYPE 0x000100000 +#define SQLITE_INNOCUOUS 0x000200000 + +/* +** CAPI3REF: Deprecated Functions +** DEPRECATED +** +** These functions are [deprecated]. In order to maintain +** backwards compatibility with older code, these functions continue +** to be supported. However, new applications should avoid +** the use of these functions. To encourage programmers to avoid +** these functions, we will not explain what they do. +*/ +#ifndef SQLITE_OMIT_DEPRECATED +SQLITE_API SQLITE_DEPRECATED int tdsqlite3_aggregate_count(tdsqlite3_context*); +SQLITE_API SQLITE_DEPRECATED int tdsqlite3_expired(tdsqlite3_stmt*); +SQLITE_API SQLITE_DEPRECATED int tdsqlite3_transfer_bindings(tdsqlite3_stmt*, tdsqlite3_stmt*); +SQLITE_API SQLITE_DEPRECATED int tdsqlite3_global_recover(void); +SQLITE_API SQLITE_DEPRECATED void tdsqlite3_thread_cleanup(void); +SQLITE_API SQLITE_DEPRECATED int tdsqlite3_memory_alarm(void(*)(void*,tdsqlite3_int64,int), + void*,tdsqlite3_int64); +#endif + +/* +** CAPI3REF: Obtaining SQL Values +** METHOD: tdsqlite3_value +** +** Summary: +**
+**
tdsqlite3_value_blob→BLOB value +**
tdsqlite3_value_double→REAL value +**
tdsqlite3_value_int→32-bit INTEGER value +**
tdsqlite3_value_int64→64-bit INTEGER value +**
tdsqlite3_value_pointer→Pointer value +**
tdsqlite3_value_text→UTF-8 TEXT value +**
tdsqlite3_value_text16→UTF-16 TEXT value in +** the native byteorder +**
tdsqlite3_value_text16be→UTF-16be TEXT value +**
tdsqlite3_value_text16le→UTF-16le TEXT value +**
    +**
tdsqlite3_value_bytes→Size of a BLOB +** or a UTF-8 TEXT in bytes +**
tdsqlite3_value_bytes16   +** →  Size of UTF-16 +** TEXT in bytes +**
tdsqlite3_value_type→Default +** datatype of the value +**
tdsqlite3_value_numeric_type   +** →  Best numeric datatype of the value +**
tdsqlite3_value_nochange   +** →  True if the column is unchanged in an UPDATE +** against a virtual table. +**
tdsqlite3_value_frombind   +** →  True if value originated from a [bound parameter] +**
+** +** Details: +** +** These routines extract type, size, and content information from +** [protected tdsqlite3_value] objects. Protected tdsqlite3_value objects +** are used to pass parameter information into the functions that +** implement [application-defined SQL functions] and [virtual tables]. +** +** These routines work only with [protected tdsqlite3_value] objects. +** Any attempt to use these routines on an [unprotected tdsqlite3_value] +** is not threadsafe. +** +** ^These routines work just like the corresponding [column access functions] +** except that these routines take a single [protected tdsqlite3_value] object +** pointer instead of a [tdsqlite3_stmt*] pointer and an integer column number. +** +** ^The tdsqlite3_value_text16() interface extracts a UTF-16 string +** in the native byte-order of the host machine. ^The +** tdsqlite3_value_text16be() and tdsqlite3_value_text16le() interfaces +** extract UTF-16 strings as big-endian and little-endian respectively. +** +** ^If [tdsqlite3_value] object V was initialized +** using [tdsqlite3_bind_pointer(S,I,P,X,D)] or [tdsqlite3_result_pointer(C,P,X,D)] +** and if X and Y are strings that compare equal according to strcmp(X,Y), +** then tdsqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise, +** tdsqlite3_value_pointer(V,Y) returns a NULL. The tdsqlite3_bind_pointer() +** routine is part of the [pointer passing interface] added for SQLite 3.20.0. +** +** ^(The tdsqlite3_value_type(V) interface returns the +** [SQLITE_INTEGER | datatype code] for the initial datatype of the +** [tdsqlite3_value] object V. The returned value is one of [SQLITE_INTEGER], +** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].)^ +** Other interfaces might change the datatype for an tdsqlite3_value object. +** For example, if the datatype is initially SQLITE_INTEGER and +** tdsqlite3_value_text(V) is called to extract a text value for that +** integer, then subsequent calls to tdsqlite3_value_type(V) might return +** SQLITE_TEXT. Whether or not a persistent internal datatype conversion +** occurs is undefined and may change from one release of SQLite to the next. +** +** ^(The tdsqlite3_value_numeric_type() interface attempts to apply +** numeric affinity to the value. This means that an attempt is +** made to convert the value to an integer or floating point. If +** such a conversion is possible without loss of information (in other +** words, if the value is a string that looks like a number) +** then the conversion is performed. Otherwise no conversion occurs. +** The [SQLITE_INTEGER | datatype] after conversion is returned.)^ +** +** ^Within the [xUpdate] method of a [virtual table], the +** tdsqlite3_value_nochange(X) interface returns true if and only if +** the column corresponding to X is unchanged by the UPDATE operation +** that the xUpdate method call was invoked to implement and if +** and the prior [xColumn] method call that was invoked to extracted +** the value for that column returned without setting a result (probably +** because it queried [tdsqlite3_vtab_nochange()] and found that the column +** was unchanging). ^Within an [xUpdate] method, any value for which +** tdsqlite3_value_nochange(X) is true will in all other respects appear +** to be a NULL value. If tdsqlite3_value_nochange(X) is invoked anywhere other +** than within an [xUpdate] method call for an UPDATE statement, then +** the return value is arbitrary and meaningless. +** +** ^The tdsqlite3_value_frombind(X) interface returns non-zero if the +** value X originated from one of the [tdsqlite3_bind_int|tdsqlite3_bind()] +** interfaces. ^If X comes from an SQL literal value, or a table column, +** or an expression, then tdsqlite3_value_frombind(X) returns zero. +** +** Please pay particular attention to the fact that the pointer returned +** from [tdsqlite3_value_blob()], [tdsqlite3_value_text()], or +** [tdsqlite3_value_text16()] can be invalidated by a subsequent call to +** [tdsqlite3_value_bytes()], [tdsqlite3_value_bytes16()], [tdsqlite3_value_text()], +** or [tdsqlite3_value_text16()]. +** +** These routines must be called from the same thread as +** the SQL function that supplied the [tdsqlite3_value*] parameters. +** +** As long as the input parameter is correct, these routines can only +** fail if an out-of-memory error occurs during a format conversion. +** Only the following subset of interfaces are subject to out-of-memory +** errors: +** +**
    +**
  • tdsqlite3_value_blob() +**
  • tdsqlite3_value_text() +**
  • tdsqlite3_value_text16() +**
  • tdsqlite3_value_text16le() +**
  • tdsqlite3_value_text16be() +**
  • tdsqlite3_value_bytes() +**
  • tdsqlite3_value_bytes16() +**
+** +** If an out-of-memory error occurs, then the return value from these +** routines is the same as if the column had contained an SQL NULL value. +** Valid SQL NULL returns can be distinguished from out-of-memory errors +** by invoking the [tdsqlite3_errcode()] immediately after the suspect +** return value is obtained and before any +** other SQLite interface is called on the same [database connection]. +*/ +SQLITE_API const void *tdsqlite3_value_blob(tdsqlite3_value*); +SQLITE_API double tdsqlite3_value_double(tdsqlite3_value*); +SQLITE_API int tdsqlite3_value_int(tdsqlite3_value*); +SQLITE_API tdsqlite3_int64 tdsqlite3_value_int64(tdsqlite3_value*); +SQLITE_API void *tdsqlite3_value_pointer(tdsqlite3_value*, const char*); +SQLITE_API const unsigned char *tdsqlite3_value_text(tdsqlite3_value*); +SQLITE_API const void *tdsqlite3_value_text16(tdsqlite3_value*); +SQLITE_API const void *tdsqlite3_value_text16le(tdsqlite3_value*); +SQLITE_API const void *tdsqlite3_value_text16be(tdsqlite3_value*); +SQLITE_API int tdsqlite3_value_bytes(tdsqlite3_value*); +SQLITE_API int tdsqlite3_value_bytes16(tdsqlite3_value*); +SQLITE_API int tdsqlite3_value_type(tdsqlite3_value*); +SQLITE_API int tdsqlite3_value_numeric_type(tdsqlite3_value*); +SQLITE_API int tdsqlite3_value_nochange(tdsqlite3_value*); +SQLITE_API int tdsqlite3_value_frombind(tdsqlite3_value*); + +/* +** CAPI3REF: Finding The Subtype Of SQL Values +** METHOD: tdsqlite3_value +** +** The tdsqlite3_value_subtype(V) function returns the subtype for +** an [application-defined SQL function] argument V. The subtype +** information can be used to pass a limited amount of context from +** one SQL function to another. Use the [tdsqlite3_result_subtype()] +** routine to set the subtype for the return value of an SQL function. +*/ +SQLITE_API unsigned int tdsqlite3_value_subtype(tdsqlite3_value*); + +/* +** CAPI3REF: Copy And Free SQL Values +** METHOD: tdsqlite3_value +** +** ^The tdsqlite3_value_dup(V) interface makes a copy of the [tdsqlite3_value] +** object D and returns a pointer to that copy. ^The [tdsqlite3_value] returned +** is a [protected tdsqlite3_value] object even if the input is not. +** ^The tdsqlite3_value_dup(V) interface returns NULL if V is NULL or if a +** memory allocation fails. +** +** ^The tdsqlite3_value_free(V) interface frees an [tdsqlite3_value] object +** previously obtained from [tdsqlite3_value_dup()]. ^If V is a NULL pointer +** then tdsqlite3_value_free(V) is a harmless no-op. +*/ +SQLITE_API tdsqlite3_value *tdsqlite3_value_dup(const tdsqlite3_value*); +SQLITE_API void tdsqlite3_value_free(tdsqlite3_value*); + +/* +** CAPI3REF: Obtain Aggregate Function Context +** METHOD: tdsqlite3_context +** +** Implementations of aggregate SQL functions use this +** routine to allocate memory for storing their state. +** +** ^The first time the tdsqlite3_aggregate_context(C,N) routine is called +** for a particular aggregate function, SQLite allocates +** N bytes of memory, zeroes out that memory, and returns a pointer +** to the new memory. ^On second and subsequent calls to +** tdsqlite3_aggregate_context() for the same aggregate function instance, +** the same buffer is returned. Sqlite3_aggregate_context() is normally +** called once for each invocation of the xStep callback and then one +** last time when the xFinal callback is invoked. ^(When no rows match +** an aggregate query, the xStep() callback of the aggregate function +** implementation is never called and xFinal() is called exactly once. +** In those cases, tdsqlite3_aggregate_context() might be called for the +** first time from within xFinal().)^ +** +** ^The tdsqlite3_aggregate_context(C,N) routine returns a NULL pointer +** when first called if N is less than or equal to zero or if a memory +** allocate error occurs. +** +** ^(The amount of space allocated by tdsqlite3_aggregate_context(C,N) is +** determined by the N parameter on first successful call. Changing the +** value of N in any subsequents call to tdsqlite3_aggregate_context() within +** the same aggregate function instance will not resize the memory +** allocation.)^ Within the xFinal callback, it is customary to set +** N=0 in calls to tdsqlite3_aggregate_context(C,N) so that no +** pointless memory allocations occur. +** +** ^SQLite automatically frees the memory allocated by +** tdsqlite3_aggregate_context() when the aggregate query concludes. +** +** The first parameter must be a copy of the +** [tdsqlite3_context | SQL function context] that is the first parameter +** to the xStep or xFinal callback routine that implements the aggregate +** function. +** +** This routine must be called from the same thread in which +** the aggregate SQL function is running. +*/ +SQLITE_API void *tdsqlite3_aggregate_context(tdsqlite3_context*, int nBytes); + +/* +** CAPI3REF: User Data For Functions +** METHOD: tdsqlite3_context +** +** ^The tdsqlite3_user_data() interface returns a copy of +** the pointer that was the pUserData parameter (the 5th parameter) +** of the [tdsqlite3_create_function()] +** and [tdsqlite3_create_function16()] routines that originally +** registered the application defined function. +** +** This routine must be called from the same thread in which +** the application-defined function is running. +*/ +SQLITE_API void *tdsqlite3_user_data(tdsqlite3_context*); + +/* +** CAPI3REF: Database Connection For Functions +** METHOD: tdsqlite3_context +** +** ^The tdsqlite3_context_db_handle() interface returns a copy of +** the pointer to the [database connection] (the 1st parameter) +** of the [tdsqlite3_create_function()] +** and [tdsqlite3_create_function16()] routines that originally +** registered the application defined function. +*/ +SQLITE_API tdsqlite3 *tdsqlite3_context_db_handle(tdsqlite3_context*); + +/* +** CAPI3REF: Function Auxiliary Data +** METHOD: tdsqlite3_context +** +** These functions may be used by (non-aggregate) SQL functions to +** associate metadata with argument values. If the same value is passed to +** multiple invocations of the same SQL function during query execution, under +** some circumstances the associated metadata may be preserved. An example +** of where this might be useful is in a regular-expression matching +** function. The compiled version of the regular expression can be stored as +** metadata associated with the pattern string. +** Then as long as the pattern string remains the same, +** the compiled regular expression can be reused on multiple +** invocations of the same function. +** +** ^The tdsqlite3_get_auxdata(C,N) interface returns a pointer to the metadata +** associated by the tdsqlite3_set_auxdata(C,N,P,X) function with the Nth argument +** value to the application-defined function. ^N is zero for the left-most +** function argument. ^If there is no metadata +** associated with the function argument, the tdsqlite3_get_auxdata(C,N) interface +** returns a NULL pointer. +** +** ^The tdsqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th +** argument of the application-defined function. ^Subsequent +** calls to tdsqlite3_get_auxdata(C,N) return P from the most recent +** tdsqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or +** NULL if the metadata has been discarded. +** ^After each call to tdsqlite3_set_auxdata(C,N,P,X) where X is not NULL, +** SQLite will invoke the destructor function X with parameter P exactly +** once, when the metadata is discarded. +** SQLite is free to discard the metadata at any time, including:
    +**
  • ^(when the corresponding function parameter changes)^, or +**
  • ^(when [tdsqlite3_reset()] or [tdsqlite3_finalize()] is called for the +** SQL statement)^, or +**
  • ^(when tdsqlite3_set_auxdata() is invoked again on the same +** parameter)^, or +**
  • ^(during the original tdsqlite3_set_auxdata() call when a memory +** allocation error occurs.)^
+** +** Note the last bullet in particular. The destructor X in +** tdsqlite3_set_auxdata(C,N,P,X) might be called immediately, before the +** tdsqlite3_set_auxdata() interface even returns. Hence tdsqlite3_set_auxdata() +** should be called near the end of the function implementation and the +** function implementation should not make any use of P after +** tdsqlite3_set_auxdata() has been called. +** +** ^(In practice, metadata is preserved between function calls for +** function parameters that are compile-time constants, including literal +** values and [parameters] and expressions composed from the same.)^ +** +** The value of the N parameter to these interfaces should be non-negative. +** Future enhancements may make use of negative N values to define new +** kinds of function caching behavior. +** +** These routines must be called from the same thread in which +** the SQL function is running. +*/ +SQLITE_API void *tdsqlite3_get_auxdata(tdsqlite3_context*, int N); +SQLITE_API void tdsqlite3_set_auxdata(tdsqlite3_context*, int N, void*, void (*)(void*)); + + +/* +** CAPI3REF: Constants Defining Special Destructor Behavior +** +** These are special values for the destructor that is passed in as the +** final argument to routines like [tdsqlite3_result_blob()]. ^If the destructor +** argument is SQLITE_STATIC, it means that the content pointer is constant +** and will never change. It does not need to be destroyed. ^The +** SQLITE_TRANSIENT value means that the content will likely change in +** the near future and that SQLite should make its own private copy of +** the content before returning. +** +** The typedef is necessary to work around problems in certain +** C++ compilers. +*/ +typedef void (*tdsqlite3_destructor_type)(void*); +#define SQLITE_STATIC ((tdsqlite3_destructor_type)0) +#define SQLITE_TRANSIENT ((tdsqlite3_destructor_type)-1) + +/* +** CAPI3REF: Setting The Result Of An SQL Function +** METHOD: tdsqlite3_context +** +** These routines are used by the xFunc or xFinal callbacks that +** implement SQL functions and aggregates. See +** [tdsqlite3_create_function()] and [tdsqlite3_create_function16()] +** for additional information. +** +** These functions work very much like the [parameter binding] family of +** functions used to bind values to host parameters in prepared statements. +** Refer to the [SQL parameter] documentation for additional information. +** +** ^The tdsqlite3_result_blob() interface sets the result from +** an application-defined function to be the BLOB whose content is pointed +** to by the second parameter and which is N bytes long where N is the +** third parameter. +** +** ^The tdsqlite3_result_zeroblob(C,N) and tdsqlite3_result_zeroblob64(C,N) +** interfaces set the result of the application-defined function to be +** a BLOB containing all zero bytes and N bytes in size. +** +** ^The tdsqlite3_result_double() interface sets the result from +** an application-defined function to be a floating point value specified +** by its 2nd argument. +** +** ^The tdsqlite3_result_error() and tdsqlite3_result_error16() functions +** cause the implemented SQL function to throw an exception. +** ^SQLite uses the string pointed to by the +** 2nd parameter of tdsqlite3_result_error() or tdsqlite3_result_error16() +** as the text of an error message. ^SQLite interprets the error +** message string from tdsqlite3_result_error() as UTF-8. ^SQLite +** interprets the string from tdsqlite3_result_error16() as UTF-16 in native +** byte order. ^If the third parameter to tdsqlite3_result_error() +** or tdsqlite3_result_error16() is negative then SQLite takes as the error +** message all text up through the first zero character. +** ^If the third parameter to tdsqlite3_result_error() or +** tdsqlite3_result_error16() is non-negative then SQLite takes that many +** bytes (not characters) from the 2nd parameter as the error message. +** ^The tdsqlite3_result_error() and tdsqlite3_result_error16() +** routines make a private copy of the error message text before +** they return. Hence, the calling function can deallocate or +** modify the text after they return without harm. +** ^The tdsqlite3_result_error_code() function changes the error code +** returned by SQLite as a result of an error in a function. ^By default, +** the error code is SQLITE_ERROR. ^A subsequent call to tdsqlite3_result_error() +** or tdsqlite3_result_error16() resets the error code to SQLITE_ERROR. +** +** ^The tdsqlite3_result_error_toobig() interface causes SQLite to throw an +** error indicating that a string or BLOB is too long to represent. +** +** ^The tdsqlite3_result_error_nomem() interface causes SQLite to throw an +** error indicating that a memory allocation failed. +** +** ^The tdsqlite3_result_int() interface sets the return value +** of the application-defined function to be the 32-bit signed integer +** value given in the 2nd argument. +** ^The tdsqlite3_result_int64() interface sets the return value +** of the application-defined function to be the 64-bit signed integer +** value given in the 2nd argument. +** +** ^The tdsqlite3_result_null() interface sets the return value +** of the application-defined function to be NULL. +** +** ^The tdsqlite3_result_text(), tdsqlite3_result_text16(), +** tdsqlite3_result_text16le(), and tdsqlite3_result_text16be() interfaces +** set the return value of the application-defined function to be +** a text string which is represented as UTF-8, UTF-16 native byte order, +** UTF-16 little endian, or UTF-16 big endian, respectively. +** ^The tdsqlite3_result_text64() interface sets the return value of an +** application-defined function to be a text string in an encoding +** specified by the fifth (and last) parameter, which must be one +** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]. +** ^SQLite takes the text result from the application from +** the 2nd parameter of the tdsqlite3_result_text* interfaces. +** ^If the 3rd parameter to the tdsqlite3_result_text* interfaces +** is negative, then SQLite takes result text from the 2nd parameter +** through the first zero character. +** ^If the 3rd parameter to the tdsqlite3_result_text* interfaces +** is non-negative, then as many bytes (not characters) of the text +** pointed to by the 2nd parameter are taken as the application-defined +** function result. If the 3rd parameter is non-negative, then it +** must be the byte offset into the string where the NUL terminator would +** appear if the string where NUL terminated. If any NUL characters occur +** in the string at a byte offset that is less than the value of the 3rd +** parameter, then the resulting string will contain embedded NULs and the +** result of expressions operating on strings with embedded NULs is undefined. +** ^If the 4th parameter to the tdsqlite3_result_text* interfaces +** or tdsqlite3_result_blob is a non-NULL pointer, then SQLite calls that +** function as the destructor on the text or BLOB result when it has +** finished using that result. +** ^If the 4th parameter to the tdsqlite3_result_text* interfaces or to +** tdsqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite +** assumes that the text or BLOB result is in constant space and does not +** copy the content of the parameter nor call a destructor on the content +** when it has finished using that result. +** ^If the 4th parameter to the tdsqlite3_result_text* interfaces +** or tdsqlite3_result_blob is the special constant SQLITE_TRANSIENT +** then SQLite makes a copy of the result into space obtained +** from [tdsqlite3_malloc()] before it returns. +** +** ^The tdsqlite3_result_value() interface sets the result of +** the application-defined function to be a copy of the +** [unprotected tdsqlite3_value] object specified by the 2nd parameter. ^The +** tdsqlite3_result_value() interface makes a copy of the [tdsqlite3_value] +** so that the [tdsqlite3_value] specified in the parameter may change or +** be deallocated after tdsqlite3_result_value() returns without harm. +** ^A [protected tdsqlite3_value] object may always be used where an +** [unprotected tdsqlite3_value] object is required, so either +** kind of [tdsqlite3_value] object can be used with this interface. +** +** ^The tdsqlite3_result_pointer(C,P,T,D) interface sets the result to an +** SQL NULL value, just like [tdsqlite3_result_null(C)], except that it +** also associates the host-language pointer P or type T with that +** NULL value such that the pointer can be retrieved within an +** [application-defined SQL function] using [tdsqlite3_value_pointer()]. +** ^If the D parameter is not NULL, then it is a pointer to a destructor +** for the P parameter. ^SQLite invokes D with P as its only argument +** when SQLite is finished with P. The T parameter should be a static +** string and preferably a string literal. The tdsqlite3_result_pointer() +** routine is part of the [pointer passing interface] added for SQLite 3.20.0. +** +** If these routines are called from within the different thread +** than the one containing the application-defined function that received +** the [tdsqlite3_context] pointer, the results are undefined. +*/ +SQLITE_API void tdsqlite3_result_blob(tdsqlite3_context*, const void*, int, void(*)(void*)); +SQLITE_API void tdsqlite3_result_blob64(tdsqlite3_context*,const void*, + tdsqlite3_uint64,void(*)(void*)); +SQLITE_API void tdsqlite3_result_double(tdsqlite3_context*, double); +SQLITE_API void tdsqlite3_result_error(tdsqlite3_context*, const char*, int); +SQLITE_API void tdsqlite3_result_error16(tdsqlite3_context*, const void*, int); +SQLITE_API void tdsqlite3_result_error_toobig(tdsqlite3_context*); +SQLITE_API void tdsqlite3_result_error_nomem(tdsqlite3_context*); +SQLITE_API void tdsqlite3_result_error_code(tdsqlite3_context*, int); +SQLITE_API void tdsqlite3_result_int(tdsqlite3_context*, int); +SQLITE_API void tdsqlite3_result_int64(tdsqlite3_context*, tdsqlite3_int64); +SQLITE_API void tdsqlite3_result_null(tdsqlite3_context*); +SQLITE_API void tdsqlite3_result_text(tdsqlite3_context*, const char*, int, void(*)(void*)); +SQLITE_API void tdsqlite3_result_text64(tdsqlite3_context*, const char*,tdsqlite3_uint64, + void(*)(void*), unsigned char encoding); +SQLITE_API void tdsqlite3_result_text16(tdsqlite3_context*, const void*, int, void(*)(void*)); +SQLITE_API void tdsqlite3_result_text16le(tdsqlite3_context*, const void*, int,void(*)(void*)); +SQLITE_API void tdsqlite3_result_text16be(tdsqlite3_context*, const void*, int,void(*)(void*)); +SQLITE_API void tdsqlite3_result_value(tdsqlite3_context*, tdsqlite3_value*); +SQLITE_API void tdsqlite3_result_pointer(tdsqlite3_context*, void*,const char*,void(*)(void*)); +SQLITE_API void tdsqlite3_result_zeroblob(tdsqlite3_context*, int n); +SQLITE_API int tdsqlite3_result_zeroblob64(tdsqlite3_context*, tdsqlite3_uint64 n); + + +/* +** CAPI3REF: Setting The Subtype Of An SQL Function +** METHOD: tdsqlite3_context +** +** The tdsqlite3_result_subtype(C,T) function causes the subtype of +** the result from the [application-defined SQL function] with +** [tdsqlite3_context] C to be the value T. Only the lower 8 bits +** of the subtype T are preserved in current versions of SQLite; +** higher order bits are discarded. +** The number of subtype bytes preserved by SQLite might increase +** in future releases of SQLite. +*/ +SQLITE_API void tdsqlite3_result_subtype(tdsqlite3_context*,unsigned int); + +/* +** CAPI3REF: Define New Collating Sequences +** METHOD: tdsqlite3 +** +** ^These functions add, remove, or modify a [collation] associated +** with the [database connection] specified as the first argument. +** +** ^The name of the collation is a UTF-8 string +** for tdsqlite3_create_collation() and tdsqlite3_create_collation_v2() +** and a UTF-16 string in native byte order for tdsqlite3_create_collation16(). +** ^Collation names that compare equal according to [tdsqlite3_strnicmp()] are +** considered to be the same name. +** +** ^(The third argument (eTextRep) must be one of the constants: +**
    +**
  • [SQLITE_UTF8], +**
  • [SQLITE_UTF16LE], +**
  • [SQLITE_UTF16BE], +**
  • [SQLITE_UTF16], or +**
  • [SQLITE_UTF16_ALIGNED]. +**
)^ +** ^The eTextRep argument determines the encoding of strings passed +** to the collating function callback, xCompare. +** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep +** force strings to be UTF16 with native byte order. +** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin +** on an even byte address. +** +** ^The fourth argument, pArg, is an application data pointer that is passed +** through as the first argument to the collating function callback. +** +** ^The fifth argument, xCompare, is a pointer to the collating function. +** ^Multiple collating functions can be registered using the same name but +** with different eTextRep parameters and SQLite will use whichever +** function requires the least amount of data transformation. +** ^If the xCompare argument is NULL then the collating function is +** deleted. ^When all collating functions having the same name are deleted, +** that collation is no longer usable. +** +** ^The collating function callback is invoked with a copy of the pArg +** application data pointer and with two strings in the encoding specified +** by the eTextRep argument. The two integer parameters to the collating +** function callback are the length of the two strings, in bytes. The collating +** function must return an integer that is negative, zero, or positive +** if the first string is less than, equal to, or greater than the second, +** respectively. A collating function must always return the same answer +** given the same inputs. If two or more collating functions are registered +** to the same collation name (using different eTextRep values) then all +** must give an equivalent answer when invoked with equivalent strings. +** The collating function must obey the following properties for all +** strings A, B, and C: +** +**
    +**
  1. If A==B then B==A. +**
  2. If A==B and B==C then A==C. +**
  3. If A<B THEN B>A. +**
  4. If A<B and B<C then A<C. +**
+** +** If a collating function fails any of the above constraints and that +** collating function is registered and used, then the behavior of SQLite +** is undefined. +** +** ^The tdsqlite3_create_collation_v2() works like tdsqlite3_create_collation() +** with the addition that the xDestroy callback is invoked on pArg when +** the collating function is deleted. +** ^Collating functions are deleted when they are overridden by later +** calls to the collation creation functions or when the +** [database connection] is closed using [tdsqlite3_close()]. +** +** ^The xDestroy callback is not called if the +** tdsqlite3_create_collation_v2() function fails. Applications that invoke +** tdsqlite3_create_collation_v2() with a non-NULL xDestroy argument should +** check the return code and dispose of the application data pointer +** themselves rather than expecting SQLite to deal with it for them. +** This is different from every other SQLite interface. The inconsistency +** is unfortunate but cannot be changed without breaking backwards +** compatibility. +** +** See also: [tdsqlite3_collation_needed()] and [tdsqlite3_collation_needed16()]. +*/ +SQLITE_API int tdsqlite3_create_collation( + tdsqlite3*, + const char *zName, + int eTextRep, + void *pArg, + int(*xCompare)(void*,int,const void*,int,const void*) +); +SQLITE_API int tdsqlite3_create_collation_v2( + tdsqlite3*, + const char *zName, + int eTextRep, + void *pArg, + int(*xCompare)(void*,int,const void*,int,const void*), + void(*xDestroy)(void*) +); +SQLITE_API int tdsqlite3_create_collation16( + tdsqlite3*, + const void *zName, + int eTextRep, + void *pArg, + int(*xCompare)(void*,int,const void*,int,const void*) +); + +/* +** CAPI3REF: Collation Needed Callbacks +** METHOD: tdsqlite3 +** +** ^To avoid having to register all collation sequences before a database +** can be used, a single callback function may be registered with the +** [database connection] to be invoked whenever an undefined collation +** sequence is required. +** +** ^If the function is registered using the tdsqlite3_collation_needed() API, +** then it is passed the names of undefined collation sequences as strings +** encoded in UTF-8. ^If tdsqlite3_collation_needed16() is used, +** the names are passed as UTF-16 in machine native byte order. +** ^A call to either function replaces the existing collation-needed callback. +** +** ^(When the callback is invoked, the first argument passed is a copy +** of the second argument to tdsqlite3_collation_needed() or +** tdsqlite3_collation_needed16(). The second argument is the database +** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE], +** or [SQLITE_UTF16LE], indicating the most desirable form of the collation +** sequence function required. The fourth parameter is the name of the +** required collation sequence.)^ +** +** The callback function should register the desired collation using +** [tdsqlite3_create_collation()], [tdsqlite3_create_collation16()], or +** [tdsqlite3_create_collation_v2()]. +*/ +SQLITE_API int tdsqlite3_collation_needed( + tdsqlite3*, + void*, + void(*)(void*,tdsqlite3*,int eTextRep,const char*) +); +SQLITE_API int tdsqlite3_collation_needed16( + tdsqlite3*, + void*, + void(*)(void*,tdsqlite3*,int eTextRep,const void*) +); + +#ifdef SQLITE_HAS_CODEC +/* +** Specify the key for an encrypted database. This routine should be +** called right after tdsqlite3_open(). +** +** The code to implement this API is not available in the public release +** of SQLite. +*/ +SQLITE_API int tdsqlite3_key( + tdsqlite3 *db, /* Database to be rekeyed */ + const void *pKey, int nKey /* The key */ +); +SQLITE_API int tdsqlite3_key_v2( + tdsqlite3 *db, /* Database to be rekeyed */ + const char *zDbName, /* Name of the database */ + const void *pKey, int nKey /* The key */ +); + +/* +** Change the key on an open database. If the current database is not +** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the +** database is decrypted. +** +** The code to implement this API is not available in the public release +** of SQLite. +*/ +/* BEGIN SQLCIPHER + SQLCipher usage note: + + If the current database is plaintext SQLCipher will NOT encrypt it. + If the current database is encrypted and pNew==0 or nNew==0, SQLCipher + will NOT decrypt it. + + This routine will ONLY work on an already encrypted database in order + to change the key. + + Conversion from plaintext-to-encrypted or encrypted-to-plaintext should + use an ATTACHed database and the sqlcipher_export() convenience function + as per the SQLCipher Documentation. + + END SQLCIPHER +*/ +SQLITE_API int tdsqlite3_rekey( + tdsqlite3 *db, /* Database to be rekeyed */ + const void *pKey, int nKey /* The new key */ +); +SQLITE_API int tdsqlite3_rekey_v2( + tdsqlite3 *db, /* Database to be rekeyed */ + const char *zDbName, /* Name of the database */ + const void *pKey, int nKey /* The new key */ +); + +/* +** Specify the activation key for a SEE database. Unless +** activated, none of the SEE routines will work. +*/ +SQLITE_API void tdsqlite3_activate_see( + const char *zPassPhrase /* Activation phrase */ +); +#endif + +#ifdef SQLITE_ENABLE_CEROD +/* +** Specify the activation key for a CEROD database. Unless +** activated, none of the CEROD routines will work. +*/ +SQLITE_API void tdsqlite3_activate_cerod( + const char *zPassPhrase /* Activation phrase */ +); +#endif + +/* +** CAPI3REF: Suspend Execution For A Short Time +** +** The tdsqlite3_sleep() function causes the current thread to suspend execution +** for at least a number of milliseconds specified in its parameter. +** +** If the operating system does not support sleep requests with +** millisecond time resolution, then the time will be rounded up to +** the nearest second. The number of milliseconds of sleep actually +** requested from the operating system is returned. +** +** ^SQLite implements this interface by calling the xSleep() +** method of the default [tdsqlite3_vfs] object. If the xSleep() method +** of the default VFS is not implemented correctly, or not implemented at +** all, then the behavior of tdsqlite3_sleep() may deviate from the description +** in the previous paragraphs. +*/ +SQLITE_API int tdsqlite3_sleep(int); + +/* +** CAPI3REF: Name Of The Folder Holding Temporary Files +** +** ^(If this global variable is made to point to a string which is +** the name of a folder (a.k.a. directory), then all temporary files +** created by SQLite when using a built-in [tdsqlite3_vfs | VFS] +** will be placed in that directory.)^ ^If this variable +** is a NULL pointer, then SQLite performs a search for an appropriate +** temporary file directory. +** +** Applications are strongly discouraged from using this global variable. +** It is required to set a temporary folder on Windows Runtime (WinRT). +** But for all other platforms, it is highly recommended that applications +** neither read nor write this variable. This global variable is a relic +** that exists for backwards compatibility of legacy applications and should +** be avoided in new projects. +** +** It is not safe to read or modify this variable in more than one +** thread at a time. It is not safe to read or modify this variable +** if a [database connection] is being used at the same time in a separate +** thread. +** It is intended that this variable be set once +** as part of process initialization and before any SQLite interface +** routines have been called and that this variable remain unchanged +** thereafter. +** +** ^The [temp_store_directory pragma] may modify this variable and cause +** it to point to memory obtained from [tdsqlite3_malloc]. ^Furthermore, +** the [temp_store_directory pragma] always assumes that any string +** that this variable points to is held in memory obtained from +** [tdsqlite3_malloc] and the pragma may attempt to free that memory +** using [tdsqlite3_free]. +** Hence, if this variable is modified directly, either it should be +** made NULL or made to point to memory obtained from [tdsqlite3_malloc] +** or else the use of the [temp_store_directory pragma] should be avoided. +** Except when requested by the [temp_store_directory pragma], SQLite +** does not free the memory that tdsqlite3_temp_directory points to. If +** the application wants that memory to be freed, it must do +** so itself, taking care to only do so after all [database connection] +** objects have been destroyed. +** +** Note to Windows Runtime users: The temporary directory must be set +** prior to calling [tdsqlite3_open] or [tdsqlite3_open_v2]. Otherwise, various +** features that require the use of temporary files may fail. Here is an +** example of how to do this using C++ with the Windows Runtime: +** +** 
+** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
+**       TemporaryFolder->Path->Data();
+** char zPathBuf[MAX_PATH + 1];
+** memset(zPathBuf, 0, sizeof(zPathBuf));
+** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
+**       NULL, NULL);
+** tdsqlite3_temp_directory = tdsqlite3_mprintf("%s", zPathBuf);
+**
+*/ +SQLITE_API SQLITE_EXTERN char *tdsqlite3_temp_directory; + +/* +** CAPI3REF: Name Of The Folder Holding Database Files +** +** ^(If this global variable is made to point to a string which is +** the name of a folder (a.k.a. directory), then all database files +** specified with a relative pathname and created or accessed by +** SQLite when using a built-in windows [tdsqlite3_vfs | VFS] will be assumed +** to be relative to that directory.)^ ^If this variable is a NULL +** pointer, then SQLite assumes that all database files specified +** with a relative pathname are relative to the current directory +** for the process. Only the windows VFS makes use of this global +** variable; it is ignored by the unix VFS. +** +** Changing the value of this variable while a database connection is +** open can result in a corrupt database. +** +** It is not safe to read or modify this variable in more than one +** thread at a time. It is not safe to read or modify this variable +** if a [database connection] is being used at the same time in a separate +** thread. +** It is intended that this variable be set once +** as part of process initialization and before any SQLite interface +** routines have been called and that this variable remain unchanged +** thereafter. +** +** ^The [data_store_directory pragma] may modify this variable and cause +** it to point to memory obtained from [tdsqlite3_malloc]. ^Furthermore, +** the [data_store_directory pragma] always assumes that any string +** that this variable points to is held in memory obtained from +** [tdsqlite3_malloc] and the pragma may attempt to free that memory +** using [tdsqlite3_free]. +** Hence, if this variable is modified directly, either it should be +** made NULL or made to point to memory obtained from [tdsqlite3_malloc] +** or else the use of the [data_store_directory pragma] should be avoided. +*/ +SQLITE_API SQLITE_EXTERN char *tdsqlite3_data_directory; + +/* +** CAPI3REF: Win32 Specific Interface +** +** These interfaces are available only on Windows. The +** [tdsqlite3_win32_set_directory] interface is used to set the value associated +** with the [tdsqlite3_temp_directory] or [tdsqlite3_data_directory] variable, to +** zValue, depending on the value of the type parameter. The zValue parameter +** should be NULL to cause the previous value to be freed via [tdsqlite3_free]; +** a non-NULL value will be copied into memory obtained from [tdsqlite3_malloc] +** prior to being used. The [tdsqlite3_win32_set_directory] interface returns +** [SQLITE_OK] to indicate success, [SQLITE_ERROR] if the type is unsupported, +** or [SQLITE_NOMEM] if memory could not be allocated. The value of the +** [tdsqlite3_data_directory] variable is intended to act as a replacement for +** the current directory on the sub-platforms of Win32 where that concept is +** not present, e.g. WinRT and UWP. The [tdsqlite3_win32_set_directory8] and +** [tdsqlite3_win32_set_directory16] interfaces behave exactly the same as the +** tdsqlite3_win32_set_directory interface except the string parameter must be +** UTF-8 or UTF-16, respectively. +*/ +SQLITE_API int tdsqlite3_win32_set_directory( + unsigned long type, /* Identifier for directory being set or reset */ + void *zValue /* New value for directory being set or reset */ +); +SQLITE_API int tdsqlite3_win32_set_directory8(unsigned long type, const char *zValue); +SQLITE_API int tdsqlite3_win32_set_directory16(unsigned long type, const void *zValue); + +/* +** CAPI3REF: Win32 Directory Types +** +** These macros are only available on Windows. They define the allowed values +** for the type argument to the [tdsqlite3_win32_set_directory] interface. +*/ +#define SQLITE_WIN32_DATA_DIRECTORY_TYPE 1 +#define SQLITE_WIN32_TEMP_DIRECTORY_TYPE 2 + +/* +** CAPI3REF: Test For Auto-Commit Mode +** KEYWORDS: {autocommit mode} +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_get_autocommit() interface returns non-zero or +** zero if the given database connection is or is not in autocommit mode, +** respectively. ^Autocommit mode is on by default. +** ^Autocommit mode is disabled by a [BEGIN] statement. +** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK]. +** +** If certain kinds of errors occur on a statement within a multi-statement +** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR], +** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the +** transaction might be rolled back automatically. The only way to +** find out whether SQLite automatically rolled back the transaction after +** an error is to use this function. +** +** If another thread changes the autocommit status of the database +** connection while this routine is running, then the return value +** is undefined. +*/ +SQLITE_API int tdsqlite3_get_autocommit(tdsqlite3*); + +/* +** CAPI3REF: Find The Database Handle Of A Prepared Statement +** METHOD: tdsqlite3_stmt +** +** ^The tdsqlite3_db_handle interface returns the [database connection] handle +** to which a [prepared statement] belongs. ^The [database connection] +** returned by tdsqlite3_db_handle is the same [database connection] +** that was the first argument +** to the [tdsqlite3_prepare_v2()] call (or its variants) that was used to +** create the statement in the first place. +*/ +SQLITE_API tdsqlite3 *tdsqlite3_db_handle(tdsqlite3_stmt*); + +/* +** CAPI3REF: Return The Filename For A Database Connection +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_db_filename(D,N) interface returns a pointer to the filename +** associated with database N of connection D. +** ^If there is no attached database N on the database +** connection D, or if database N is a temporary or in-memory database, then +** this function will return either a NULL pointer or an empty string. +** +** ^The string value returned by this routine is owned and managed by +** the database connection. ^The value will be valid until the database N +** is [DETACH]-ed or until the database connection closes. +** +** ^The filename returned by this function is the output of the +** xFullPathname method of the [VFS]. ^In other words, the filename +** will be an absolute pathname, even if the filename used +** to open the database originally was a URI or relative pathname. +** +** If the filename pointer returned by this routine is not NULL, then it +** can be used as the filename input parameter to these routines: +**
    +**
  • [tdsqlite3_uri_parameter()] +**
  • [tdsqlite3_uri_boolean()] +**
  • [tdsqlite3_uri_int64()] +**
  • [tdsqlite3_filename_database()] +**
  • [tdsqlite3_filename_journal()] +**
  • [tdsqlite3_filename_wal()] +**
+*/ +SQLITE_API const char *tdsqlite3_db_filename(tdsqlite3 *db, const char *zDbName); + +/* +** CAPI3REF: Determine if a database is read-only +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_db_readonly(D,N) interface returns 1 if the database N +** of connection D is read-only, 0 if it is read/write, or -1 if N is not +** the name of a database on connection D. +*/ +SQLITE_API int tdsqlite3_db_readonly(tdsqlite3 *db, const char *zDbName); + +/* +** CAPI3REF: Find the next prepared statement +** METHOD: tdsqlite3 +** +** ^This interface returns a pointer to the next [prepared statement] after +** pStmt associated with the [database connection] pDb. ^If pStmt is NULL +** then this interface returns a pointer to the first prepared statement +** associated with the database connection pDb. ^If no prepared statement +** satisfies the conditions of this routine, it returns NULL. +** +** The [database connection] pointer D in a call to +** [tdsqlite3_next_stmt(D,S)] must refer to an open database +** connection and in particular must not be a NULL pointer. +*/ +SQLITE_API tdsqlite3_stmt *tdsqlite3_next_stmt(tdsqlite3 *pDb, tdsqlite3_stmt *pStmt); + +/* +** CAPI3REF: Commit And Rollback Notification Callbacks +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_commit_hook() interface registers a callback +** function to be invoked whenever a transaction is [COMMIT | committed]. +** ^Any callback set by a previous call to tdsqlite3_commit_hook() +** for the same database connection is overridden. +** ^The tdsqlite3_rollback_hook() interface registers a callback +** function to be invoked whenever a transaction is [ROLLBACK | rolled back]. +** ^Any callback set by a previous call to tdsqlite3_rollback_hook() +** for the same database connection is overridden. +** ^The pArg argument is passed through to the callback. +** ^If the callback on a commit hook function returns non-zero, +** then the commit is converted into a rollback. +** +** ^The tdsqlite3_commit_hook(D,C,P) and tdsqlite3_rollback_hook(D,C,P) functions +** return the P argument from the previous call of the same function +** on the same [database connection] D, or NULL for +** the first call for each function on D. +** +** The commit and rollback hook callbacks are not reentrant. +** The callback implementation must not do anything that will modify +** the database connection that invoked the callback. Any actions +** to modify the database connection must be deferred until after the +** completion of the [tdsqlite3_step()] call that triggered the commit +** or rollback hook in the first place. +** Note that running any other SQL statements, including SELECT statements, +** or merely calling [tdsqlite3_prepare_v2()] and [tdsqlite3_step()] will modify +** the database connections for the meaning of "modify" in this paragraph. +** +** ^Registering a NULL function disables the callback. +** +** ^When the commit hook callback routine returns zero, the [COMMIT] +** operation is allowed to continue normally. ^If the commit hook +** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK]. +** ^The rollback hook is invoked on a rollback that results from a commit +** hook returning non-zero, just as it would be with any other rollback. +** +** ^For the purposes of this API, a transaction is said to have been +** rolled back if an explicit "ROLLBACK" statement is executed, or +** an error or constraint causes an implicit rollback to occur. +** ^The rollback callback is not invoked if a transaction is +** automatically rolled back because the database connection is closed. +** +** See also the [tdsqlite3_update_hook()] interface. +*/ +SQLITE_API void *tdsqlite3_commit_hook(tdsqlite3*, int(*)(void*), void*); +SQLITE_API void *tdsqlite3_rollback_hook(tdsqlite3*, void(*)(void *), void*); + +/* +** CAPI3REF: Data Change Notification Callbacks +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_update_hook() interface registers a callback function +** with the [database connection] identified by the first argument +** to be invoked whenever a row is updated, inserted or deleted in +** a [rowid table]. +** ^Any callback set by a previous call to this function +** for the same database connection is overridden. +** +** ^The second argument is a pointer to the function to invoke when a +** row is updated, inserted or deleted in a rowid table. +** ^The first argument to the callback is a copy of the third argument +** to tdsqlite3_update_hook(). +** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE], +** or [SQLITE_UPDATE], depending on the operation that caused the callback +** to be invoked. +** ^The third and fourth arguments to the callback contain pointers to the +** database and table name containing the affected row. +** ^The final callback parameter is the [rowid] of the row. +** ^In the case of an update, this is the [rowid] after the update takes place. +** +** ^(The update hook is not invoked when internal system tables are +** modified (i.e. sqlite_master and sqlite_sequence).)^ +** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified. +** +** ^In the current implementation, the update hook +** is not invoked when conflicting rows are deleted because of an +** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook +** invoked when rows are deleted using the [truncate optimization]. +** The exceptions defined in this paragraph might change in a future +** release of SQLite. +** +** The update hook implementation must not do anything that will modify +** the database connection that invoked the update hook. Any actions +** to modify the database connection must be deferred until after the +** completion of the [tdsqlite3_step()] call that triggered the update hook. +** Note that [tdsqlite3_prepare_v2()] and [tdsqlite3_step()] both modify their +** database connections for the meaning of "modify" in this paragraph. +** +** ^The tdsqlite3_update_hook(D,C,P) function +** returns the P argument from the previous call +** on the same [database connection] D, or NULL for +** the first call on D. +** +** See also the [tdsqlite3_commit_hook()], [tdsqlite3_rollback_hook()], +** and [tdsqlite3_preupdate_hook()] interfaces. +*/ +SQLITE_API void *tdsqlite3_update_hook( + tdsqlite3*, + void(*)(void *,int ,char const *,char const *,tdsqlite3_int64), + void* +); + +/* +** CAPI3REF: Enable Or Disable Shared Pager Cache +** +** ^(This routine enables or disables the sharing of the database cache +** and schema data structures between [database connection | connections] +** to the same database. Sharing is enabled if the argument is true +** and disabled if the argument is false.)^ +** +** ^Cache sharing is enabled and disabled for an entire process. +** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]). +** In prior versions of SQLite, +** sharing was enabled or disabled for each thread separately. +** +** ^(The cache sharing mode set by this interface effects all subsequent +** calls to [tdsqlite3_open()], [tdsqlite3_open_v2()], and [tdsqlite3_open16()]. +** Existing database connections continue to use the sharing mode +** that was in effect at the time they were opened.)^ +** +** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled +** successfully. An [error code] is returned otherwise.)^ +** +** ^Shared cache is disabled by default. It is recommended that it stay +** that way. In other words, do not use this routine. This interface +** continues to be provided for historical compatibility, but its use is +** discouraged. Any use of shared cache is discouraged. If shared cache +** must be used, it is recommended that shared cache only be enabled for +** individual database connections using the [tdsqlite3_open_v2()] interface +** with the [SQLITE_OPEN_SHAREDCACHE] flag. +** +** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0 +** and will always return SQLITE_MISUSE. On those systems, +** shared cache mode should be enabled per-database connection via +** [tdsqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE]. +** +** This interface is threadsafe on processors where writing a +** 32-bit integer is atomic. +** +** See Also: [SQLite Shared-Cache Mode] +*/ +SQLITE_API int tdsqlite3_enable_shared_cache(int); + +/* +** CAPI3REF: Attempt To Free Heap Memory +** +** ^The tdsqlite3_release_memory() interface attempts to free N bytes +** of heap memory by deallocating non-essential memory allocations +** held by the database library. Memory used to cache database +** pages to improve performance is an example of non-essential memory. +** ^tdsqlite3_release_memory() returns the number of bytes actually freed, +** which might be more or less than the amount requested. +** ^The tdsqlite3_release_memory() routine is a no-op returning zero +** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT]. +** +** See also: [tdsqlite3_db_release_memory()] +*/ +SQLITE_API int tdsqlite3_release_memory(int); + +/* +** CAPI3REF: Free Memory Used By A Database Connection +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_db_release_memory(D) interface attempts to free as much heap +** memory as possible from database connection D. Unlike the +** [tdsqlite3_release_memory()] interface, this interface is in effect even +** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is +** omitted. +** +** See also: [tdsqlite3_release_memory()] +*/ +SQLITE_API int tdsqlite3_db_release_memory(tdsqlite3*); + +/* +** CAPI3REF: Impose A Limit On Heap Size +** +** These interfaces impose limits on the amount of heap memory that will be +** by all database connections within a single process. +** +** ^The tdsqlite3_soft_heap_limit64() interface sets and/or queries the +** soft limit on the amount of heap memory that may be allocated by SQLite. +** ^SQLite strives to keep heap memory utilization below the soft heap +** limit by reducing the number of pages held in the page cache +** as heap memory usages approaches the limit. +** ^The soft heap limit is "soft" because even though SQLite strives to stay +** below the limit, it will exceed the limit rather than generate +** an [SQLITE_NOMEM] error. In other words, the soft heap limit +** is advisory only. +** +** ^The tdsqlite3_hard_heap_limit64(N) interface sets a hard upper bound of +** N bytes on the amount of memory that will be allocated. ^The +** tdsqlite3_hard_heap_limit64(N) interface is similar to +** tdsqlite3_soft_heap_limit64(N) except that memory allocations will fail +** when the hard heap limit is reached. +** +** ^The return value from both tdsqlite3_soft_heap_limit64() and +** tdsqlite3_hard_heap_limit64() is the size of +** the heap limit prior to the call, or negative in the case of an +** error. ^If the argument N is negative +** then no change is made to the heap limit. Hence, the current +** size of heap limits can be determined by invoking +** tdsqlite3_soft_heap_limit64(-1) or tdsqlite3_hard_heap_limit(-1). +** +** ^Setting the heap limits to zero disables the heap limiter mechanism. +** +** ^The soft heap limit may not be greater than the hard heap limit. +** ^If the hard heap limit is enabled and if tdsqlite3_soft_heap_limit(N) +** is invoked with a value of N that is greater than the hard heap limit, +** the the soft heap limit is set to the value of the hard heap limit. +** ^The soft heap limit is automatically enabled whenever the hard heap +** limit is enabled. ^When tdsqlite3_hard_heap_limit64(N) is invoked and +** the soft heap limit is outside the range of 1..N, then the soft heap +** limit is set to N. ^Invoking tdsqlite3_soft_heap_limit64(0) when the +** hard heap limit is enabled makes the soft heap limit equal to the +** hard heap limit. +** +** The memory allocation limits can also be adjusted using +** [PRAGMA soft_heap_limit] and [PRAGMA hard_heap_limit]. +** +** ^(The heap limits are not enforced in the current implementation +** if one or more of following conditions are true: +** +**
    +**
  • The limit value is set to zero. +**
  • Memory accounting is disabled using a combination of the +** [tdsqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and +** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option. +**
  • An alternative page cache implementation is specified using +** [tdsqlite3_config]([SQLITE_CONFIG_PCACHE2],...). +**
  • The page cache allocates from its own memory pool supplied +** by [tdsqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than +** from the heap. +**
)^ +** +** The circumstances under which SQLite will enforce the heap limits may +** changes in future releases of SQLite. +*/ +SQLITE_API tdsqlite3_int64 tdsqlite3_soft_heap_limit64(tdsqlite3_int64 N); +SQLITE_API tdsqlite3_int64 tdsqlite3_hard_heap_limit64(tdsqlite3_int64 N); + +/* +** CAPI3REF: Deprecated Soft Heap Limit Interface +** DEPRECATED +** +** This is a deprecated version of the [tdsqlite3_soft_heap_limit64()] +** interface. This routine is provided for historical compatibility +** only. All new applications should use the +** [tdsqlite3_soft_heap_limit64()] interface rather than this one. +*/ +SQLITE_API SQLITE_DEPRECATED void tdsqlite3_soft_heap_limit(int N); + + +/* +** CAPI3REF: Extract Metadata About A Column Of A Table +** METHOD: tdsqlite3 +** +** ^(The tdsqlite3_table_column_metadata(X,D,T,C,....) routine returns +** information about column C of table T in database D +** on [database connection] X.)^ ^The tdsqlite3_table_column_metadata() +** interface returns SQLITE_OK and fills in the non-NULL pointers in +** the final five arguments with appropriate values if the specified +** column exists. ^The tdsqlite3_table_column_metadata() interface returns +** SQLITE_ERROR if the specified column does not exist. +** ^If the column-name parameter to tdsqlite3_table_column_metadata() is a +** NULL pointer, then this routine simply checks for the existence of the +** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it +** does not. If the table name parameter T in a call to +** tdsqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is +** undefined behavior. +** +** ^The column is identified by the second, third and fourth parameters to +** this function. ^(The second parameter is either the name of the database +** (i.e. "main", "temp", or an attached database) containing the specified +** table or NULL.)^ ^If it is NULL, then all attached databases are searched +** for the table using the same algorithm used by the database engine to +** resolve unqualified table references. +** +** ^The third and fourth parameters to this function are the table and column +** name of the desired column, respectively. +** +** ^Metadata is returned by writing to the memory locations passed as the 5th +** and subsequent parameters to this function. ^Any of these arguments may be +** NULL, in which case the corresponding element of metadata is omitted. +** +** ^(
+** +**
Parameter Output
Type 		Description +** +**
5th const char* Data type +**
6th const char* Name of default collation sequence +**
7th int True if column has a NOT NULL constraint +**
8th int True if column is part of the PRIMARY KEY +**
9th int True if column is [AUTOINCREMENT] +**
+**
)^ +** +** ^The memory pointed to by the character pointers returned for the +** declaration type and collation sequence is valid until the next +** call to any SQLite API function. +** +** ^If the specified table is actually a view, an [error code] is returned. +** +** ^If the specified column is "rowid", "oid" or "_rowid_" and the table +** is not a [WITHOUT ROWID] table and an +** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output +** parameters are set for the explicitly declared column. ^(If there is no +** [INTEGER PRIMARY KEY] column, then the outputs +** for the [rowid] are set as follows: +** +** 
+**     data type: "INTEGER"
+**     collation sequence: "BINARY"
+**     not null: 0
+**     primary key: 1
+**     auto increment: 0
+**
)^ +** +** ^This function causes all database schemas to be read from disk and +** parsed, if that has not already been done, and returns an error if +** any errors are encountered while loading the schema. +*/ +SQLITE_API int tdsqlite3_table_column_metadata( + tdsqlite3 *db, /* Connection handle */ + const char *zDbName, /* Database name or NULL */ + const char *zTableName, /* Table name */ + const char *zColumnName, /* Column name */ + char const **pzDataType, /* OUTPUT: Declared data type */ + char const **pzCollSeq, /* OUTPUT: Collation sequence name */ + int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */ + int *pPrimaryKey, /* OUTPUT: True if column part of PK */ + int *pAutoinc /* OUTPUT: True if column is auto-increment */ +); + +/* +** CAPI3REF: Load An Extension +** METHOD: tdsqlite3 +** +** ^This interface loads an SQLite extension library from the named file. +** +** ^The tdsqlite3_load_extension() interface attempts to load an +** [SQLite extension] library contained in the file zFile. If +** the file cannot be loaded directly, attempts are made to load +** with various operating-system specific extensions added. +** So for example, if "samplelib" cannot be loaded, then names like +** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might +** be tried also. +** +** ^The entry point is zProc. +** ^(zProc may be 0, in which case SQLite will try to come up with an +** entry point name on its own. It first tries "tdsqlite3_extension_init". +** If that does not work, it constructs a name "tdsqlite3_X_init" where the +** X is consists of the lower-case equivalent of all ASCII alphabetic +** characters in the filename from the last "/" to the first following +** "." and omitting any initial "lib".)^ +** ^The tdsqlite3_load_extension() interface returns +** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong. +** ^If an error occurs and pzErrMsg is not 0, then the +** [tdsqlite3_load_extension()] interface shall attempt to +** fill *pzErrMsg with error message text stored in memory +** obtained from [tdsqlite3_malloc()]. The calling function +** should free this memory by calling [tdsqlite3_free()]. +** +** ^Extension loading must be enabled using +** [tdsqlite3_enable_load_extension()] or +** [tdsqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL) +** prior to calling this API, +** otherwise an error will be returned. +** +** Security warning: It is recommended that the +** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this +** interface. The use of the [tdsqlite3_enable_load_extension()] interface +** should be avoided. This will keep the SQL function [load_extension()] +** disabled and prevent SQL injections from giving attackers +** access to extension loading capabilities. +** +** See also the [load_extension() SQL function]. +*/ +SQLITE_API int tdsqlite3_load_extension( + tdsqlite3 *db, /* Load the extension into this database connection */ + const char *zFile, /* Name of the shared library containing extension */ + const char *zProc, /* Entry point. Derived from zFile if 0 */ + char **pzErrMsg /* Put error message here if not 0 */ +); + +/* +** CAPI3REF: Enable Or Disable Extension Loading +** METHOD: tdsqlite3 +** +** ^So as not to open security holes in older applications that are +** unprepared to deal with [extension loading], and as a means of disabling +** [extension loading] while evaluating user-entered SQL, the following API +** is provided to turn the [tdsqlite3_load_extension()] mechanism on and off. +** +** ^Extension loading is off by default. +** ^Call the tdsqlite3_enable_load_extension() routine with onoff==1 +** to turn extension loading on and call it with onoff==0 to turn +** it back off again. +** +** ^This interface enables or disables both the C-API +** [tdsqlite3_load_extension()] and the SQL function [load_extension()]. +** ^(Use [tdsqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..) +** to enable or disable only the C-API.)^ +** +** Security warning: It is recommended that extension loading +** be enabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method +** rather than this interface, so the [load_extension()] SQL function +** remains disabled. This will prevent SQL injections from giving attackers +** access to extension loading capabilities. +*/ +SQLITE_API int tdsqlite3_enable_load_extension(tdsqlite3 *db, int onoff); + +/* +** CAPI3REF: Automatically Load Statically Linked Extensions +** +** ^This interface causes the xEntryPoint() function to be invoked for +** each new [database connection] that is created. The idea here is that +** xEntryPoint() is the entry point for a statically linked [SQLite extension] +** that is to be automatically loaded into all new database connections. +** +** ^(Even though the function prototype shows that xEntryPoint() takes +** no arguments and returns void, SQLite invokes xEntryPoint() with three +** arguments and expects an integer result as if the signature of the +** entry point where as follows: +** +** 
+**    int xEntryPoint(
+**      tdsqlite3 *db,
+**      const char **pzErrMsg,
+**      const struct tdsqlite3_api_routines *pThunk
+**    );
+**
)^ +** +** If the xEntryPoint routine encounters an error, it should make *pzErrMsg +** point to an appropriate error message (obtained from [tdsqlite3_mprintf()]) +** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg +** is NULL before calling the xEntryPoint(). ^SQLite will invoke +** [tdsqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any +** xEntryPoint() returns an error, the [tdsqlite3_open()], [tdsqlite3_open16()], +** or [tdsqlite3_open_v2()] call that provoked the xEntryPoint() will fail. +** +** ^Calling tdsqlite3_auto_extension(X) with an entry point X that is already +** on the list of automatic extensions is a harmless no-op. ^No entry point +** will be called more than once for each database connection that is opened. +** +** See also: [tdsqlite3_reset_auto_extension()] +** and [tdsqlite3_cancel_auto_extension()] +*/ +SQLITE_API int tdsqlite3_auto_extension(void(*xEntryPoint)(void)); + +/* +** CAPI3REF: Cancel Automatic Extension Loading +** +** ^The [tdsqlite3_cancel_auto_extension(X)] interface unregisters the +** initialization routine X that was registered using a prior call to +** [tdsqlite3_auto_extension(X)]. ^The [tdsqlite3_cancel_auto_extension(X)] +** routine returns 1 if initialization routine X was successfully +** unregistered and it returns 0 if X was not on the list of initialization +** routines. +*/ +SQLITE_API int tdsqlite3_cancel_auto_extension(void(*xEntryPoint)(void)); + +/* +** CAPI3REF: Reset Automatic Extension Loading +** +** ^This interface disables all automatic extensions previously +** registered using [tdsqlite3_auto_extension()]. +*/ +SQLITE_API void tdsqlite3_reset_auto_extension(void); + +/* +** The interface to the virtual-table mechanism is currently considered +** to be experimental. The interface might change in incompatible ways. +** If this is a problem for you, do not use the interface at this time. +** +** When the virtual-table mechanism stabilizes, we will declare the +** interface fixed, support it indefinitely, and remove this comment. +*/ + +/* +** Structures used by the virtual table interface +*/ +typedef struct tdsqlite3_vtab tdsqlite3_vtab; +typedef struct tdsqlite3_index_info tdsqlite3_index_info; +typedef struct tdsqlite3_vtab_cursor tdsqlite3_vtab_cursor; +typedef struct tdsqlite3_module tdsqlite3_module; + +/* +** CAPI3REF: Virtual Table Object +** KEYWORDS: tdsqlite3_module {virtual table module} +** +** This structure, sometimes called a "virtual table module", +** defines the implementation of a [virtual table]. +** This structure consists mostly of methods for the module. +** +** ^A virtual table module is created by filling in a persistent +** instance of this structure and passing a pointer to that instance +** to [tdsqlite3_create_module()] or [tdsqlite3_create_module_v2()]. +** ^The registration remains valid until it is replaced by a different +** module or until the [database connection] closes. The content +** of this structure must not change while it is registered with +** any database connection. +*/ +struct tdsqlite3_module { + int iVersion; + int (*xCreate)(tdsqlite3*, void *pAux, + int argc, const char *const*argv, + tdsqlite3_vtab **ppVTab, char**); + int (*xConnect)(tdsqlite3*, void *pAux, + int argc, const char *const*argv, + tdsqlite3_vtab **ppVTab, char**); + int (*xBestIndex)(tdsqlite3_vtab *pVTab, tdsqlite3_index_info*); + int (*xDisconnect)(tdsqlite3_vtab *pVTab); + int (*xDestroy)(tdsqlite3_vtab *pVTab); + int (*xOpen)(tdsqlite3_vtab *pVTab, tdsqlite3_vtab_cursor **ppCursor); + int (*xClose)(tdsqlite3_vtab_cursor*); + int (*xFilter)(tdsqlite3_vtab_cursor*, int idxNum, const char *idxStr, + int argc, tdsqlite3_value **argv); + int (*xNext)(tdsqlite3_vtab_cursor*); + int (*xEof)(tdsqlite3_vtab_cursor*); + int (*xColumn)(tdsqlite3_vtab_cursor*, tdsqlite3_context*, int); + int (*xRowid)(tdsqlite3_vtab_cursor*, tdsqlite3_int64 *pRowid); + int (*xUpdate)(tdsqlite3_vtab *, int, tdsqlite3_value **, tdsqlite3_int64 *); + int (*xBegin)(tdsqlite3_vtab *pVTab); + int (*xSync)(tdsqlite3_vtab *pVTab); + int (*xCommit)(tdsqlite3_vtab *pVTab); + int (*xRollback)(tdsqlite3_vtab *pVTab); + int (*xFindFunction)(tdsqlite3_vtab *pVtab, int nArg, const char *zName, + void (**pxFunc)(tdsqlite3_context*,int,tdsqlite3_value**), + void **ppArg); + int (*xRename)(tdsqlite3_vtab *pVtab, const char *zNew); + /* The methods above are in version 1 of the sqlite_module object. Those + ** below are for version 2 and greater. */ + int (*xSavepoint)(tdsqlite3_vtab *pVTab, int); + int (*xRelease)(tdsqlite3_vtab *pVTab, int); + int (*xRollbackTo)(tdsqlite3_vtab *pVTab, int); + /* The methods above are in versions 1 and 2 of the sqlite_module object. + ** Those below are for version 3 and greater. */ + int (*xShadowName)(const char*); +}; + +/* +** CAPI3REF: Virtual Table Indexing Information +** KEYWORDS: tdsqlite3_index_info +** +** The tdsqlite3_index_info structure and its substructures is used as part +** of the [virtual table] interface to +** pass information into and receive the reply from the [xBestIndex] +** method of a [virtual table module]. The fields under **Inputs** are the +** inputs to xBestIndex and are read-only. xBestIndex inserts its +** results into the **Outputs** fields. +** +** ^(The aConstraint[] array records WHERE clause constraints of the form: +** +**
column OP expr
+** +** where OP is =, <, <=, >, or >=.)^ ^(The particular operator is +** stored in aConstraint[].op using one of the +** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^ +** ^(The index of the column is stored in +** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the +** expr on the right-hand side can be evaluated (and thus the constraint +** is usable) and false if it cannot.)^ +** +** ^The optimizer automatically inverts terms of the form "expr OP column" +** and makes other simplifications to the WHERE clause in an attempt to +** get as many WHERE clause terms into the form shown above as possible. +** ^The aConstraint[] array only reports WHERE clause terms that are +** relevant to the particular virtual table being queried. +** +** ^Information about the ORDER BY clause is stored in aOrderBy[]. +** ^Each term of aOrderBy records a column of the ORDER BY clause. +** +** The colUsed field indicates which columns of the virtual table may be +** required by the current scan. Virtual table columns are numbered from +** zero in the order in which they appear within the CREATE TABLE statement +** passed to tdsqlite3_declare_vtab(). For the first 63 columns (columns 0-62), +** the corresponding bit is set within the colUsed mask if the column may be +** required by SQLite. If the table has at least 64 columns and any column +** to the right of the first 63 is required, then bit 63 of colUsed is also +** set. In other words, column iCol may be required if the expression +** (colUsed & ((tdsqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to +** non-zero. +** +** The [xBestIndex] method must fill aConstraintUsage[] with information +** about what parameters to pass to xFilter. ^If argvIndex>0 then +** the right-hand side of the corresponding aConstraint[] is evaluated +** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit +** is true, then the constraint is assumed to be fully handled by the +** virtual table and might not be checked again by the byte code.)^ ^(The +** aConstraintUsage[].omit flag is an optimization hint. When the omit flag +** is left in its default setting of false, the constraint will always be +** checked separately in byte code. If the omit flag is change to true, then +** the constraint may or may not be checked in byte code. In other words, +** when the omit flag is true there is no guarantee that the constraint will +** not be checked again using byte code.)^ +** +** ^The idxNum and idxPtr values are recorded and passed into the +** [xFilter] method. +** ^[tdsqlite3_free()] is used to free idxPtr if and only if +** needToFreeIdxPtr is true. +** +** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in +** the correct order to satisfy the ORDER BY clause so that no separate +** sorting step is required. +** +** ^The estimatedCost value is an estimate of the cost of a particular +** strategy. A cost of N indicates that the cost of the strategy is similar +** to a linear scan of an SQLite table with N rows. A cost of log(N) +** indicates that the expense of the operation is similar to that of a +** binary search on a unique indexed field of an SQLite table with N rows. +** +** ^The estimatedRows value is an estimate of the number of rows that +** will be returned by the strategy. +** +** The xBestIndex method may optionally populate the idxFlags field with a +** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag - +** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite +** assumes that the strategy may visit at most one row. +** +** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then +** SQLite also assumes that if a call to the xUpdate() method is made as +** part of the same statement to delete or update a virtual table row and the +** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback +** any database changes. In other words, if the xUpdate() returns +** SQLITE_CONSTRAINT, the database contents must be exactly as they were +** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not +** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by +** the xUpdate method are automatically rolled back by SQLite. +** +** IMPORTANT: The estimatedRows field was added to the tdsqlite3_index_info +** structure for SQLite [version 3.8.2] ([dateof:3.8.2]). +** If a virtual table extension is +** used with an SQLite version earlier than 3.8.2, the results of attempting +** to read or write the estimatedRows field are undefined (but are likely +** to include crashing the application). The estimatedRows field should +** therefore only be used if [tdsqlite3_libversion_number()] returns a +** value greater than or equal to 3008002. Similarly, the idxFlags field +** was added for [version 3.9.0] ([dateof:3.9.0]). +** It may therefore only be used if +** tdsqlite3_libversion_number() returns a value greater than or equal to +** 3009000. +*/ +struct tdsqlite3_index_info { + /* Inputs */ + int nConstraint; /* Number of entries in aConstraint */ + struct tdsqlite3_index_constraint { + int iColumn; /* Column constrained. -1 for ROWID */ + unsigned char op; /* Constraint operator */ + unsigned char usable; /* True if this constraint is usable */ + int iTermOffset; /* Used internally - xBestIndex should ignore */ + } *aConstraint; /* Table of WHERE clause constraints */ + int nOrderBy; /* Number of terms in the ORDER BY clause */ + struct tdsqlite3_index_orderby { + int iColumn; /* Column number */ + unsigned char desc; /* True for DESC. False for ASC. */ + } *aOrderBy; /* The ORDER BY clause */ + /* Outputs */ + struct tdsqlite3_index_constraint_usage { + int argvIndex; /* if >0, constraint is part of argv to xFilter */ + unsigned char omit; /* Do not code a test for this constraint */ + } *aConstraintUsage; + int idxNum; /* Number used to identify the index */ + char *idxStr; /* String, possibly obtained from tdsqlite3_malloc */ + int needToFreeIdxStr; /* Free idxStr using tdsqlite3_free() if true */ + int orderByConsumed; /* True if output is already ordered */ + double estimatedCost; /* Estimated cost of using this index */ + /* Fields below are only available in SQLite 3.8.2 and later */ + tdsqlite3_int64 estimatedRows; /* Estimated number of rows returned */ + /* Fields below are only available in SQLite 3.9.0 and later */ + int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */ + /* Fields below are only available in SQLite 3.10.0 and later */ + tdsqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */ +}; + +/* +** CAPI3REF: Virtual Table Scan Flags +** +** Virtual table implementations are allowed to set the +** [tdsqlite3_index_info].idxFlags field to some combination of +** these bits. +*/ +#define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */ + +/* +** CAPI3REF: Virtual Table Constraint Operator Codes +** +** These macros define the allowed values for the +** [tdsqlite3_index_info].aConstraint[].op field. Each value represents +** an operator that is part of a constraint term in the wHERE clause of +** a query that uses a [virtual table]. +*/ +#define SQLITE_INDEX_CONSTRAINT_EQ 2 +#define SQLITE_INDEX_CONSTRAINT_GT 4 +#define SQLITE_INDEX_CONSTRAINT_LE 8 +#define SQLITE_INDEX_CONSTRAINT_LT 16 +#define SQLITE_INDEX_CONSTRAINT_GE 32 +#define SQLITE_INDEX_CONSTRAINT_MATCH 64 +#define SQLITE_INDEX_CONSTRAINT_LIKE 65 +#define SQLITE_INDEX_CONSTRAINT_GLOB 66 +#define SQLITE_INDEX_CONSTRAINT_REGEXP 67 +#define SQLITE_INDEX_CONSTRAINT_NE 68 +#define SQLITE_INDEX_CONSTRAINT_ISNOT 69 +#define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 +#define SQLITE_INDEX_CONSTRAINT_ISNULL 71 +#define SQLITE_INDEX_CONSTRAINT_IS 72 +#define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 + +/* +** CAPI3REF: Register A Virtual Table Implementation +** METHOD: tdsqlite3 +** +** ^These routines are used to register a new [virtual table module] name. +** ^Module names must be registered before +** creating a new [virtual table] using the module and before using a +** preexisting [virtual table] for the module. +** +** ^The module name is registered on the [database connection] specified +** by the first parameter. ^The name of the module is given by the +** second parameter. ^The third parameter is a pointer to +** the implementation of the [virtual table module]. ^The fourth +** parameter is an arbitrary client data pointer that is passed through +** into the [xCreate] and [xConnect] methods of the virtual table module +** when a new virtual table is be being created or reinitialized. +** +** ^The tdsqlite3_create_module_v2() interface has a fifth parameter which +** is a pointer to a destructor for the pClientData. ^SQLite will +** invoke the destructor function (if it is not NULL) when SQLite +** no longer needs the pClientData pointer. ^The destructor will also +** be invoked if the call to tdsqlite3_create_module_v2() fails. +** ^The tdsqlite3_create_module() +** interface is equivalent to tdsqlite3_create_module_v2() with a NULL +** destructor. +** +** ^If the third parameter (the pointer to the tdsqlite3_module object) is +** NULL then no new module is create and any existing modules with the +** same name are dropped. +** +** See also: [tdsqlite3_drop_modules()] +*/ +SQLITE_API int tdsqlite3_create_module( + tdsqlite3 *db, /* SQLite connection to register module with */ + const char *zName, /* Name of the module */ + const tdsqlite3_module *p, /* Methods for the module */ + void *pClientData /* Client data for xCreate/xConnect */ +); +SQLITE_API int tdsqlite3_create_module_v2( + tdsqlite3 *db, /* SQLite connection to register module with */ + const char *zName, /* Name of the module */ + const tdsqlite3_module *p, /* Methods for the module */ + void *pClientData, /* Client data for xCreate/xConnect */ + void(*xDestroy)(void*) /* Module destructor function */ +); + +/* +** CAPI3REF: Remove Unnecessary Virtual Table Implementations +** METHOD: tdsqlite3 +** +** ^The tdsqlite3_drop_modules(D,L) interface removes all virtual +** table modules from database connection D except those named on list L. +** The L parameter must be either NULL or a pointer to an array of pointers +** to strings where the array is terminated by a single NULL pointer. +** ^If the L parameter is NULL, then all virtual table modules are removed. +** +** See also: [tdsqlite3_create_module()] +*/ +SQLITE_API int tdsqlite3_drop_modules( + tdsqlite3 *db, /* Remove modules from this connection */ + const char **azKeep /* Except, do not remove the ones named here */ +); + +/* +** CAPI3REF: Virtual Table Instance Object +** KEYWORDS: tdsqlite3_vtab +** +** Every [virtual table module] implementation uses a subclass +** of this object to describe a particular instance +** of the [virtual table]. Each subclass will +** be tailored to the specific needs of the module implementation. +** The purpose of this superclass is to define certain fields that are +** common to all module implementations. +** +** ^Virtual tables methods can set an error message by assigning a +** string obtained from [tdsqlite3_mprintf()] to zErrMsg. The method should +** take care that any prior string is freed by a call to [tdsqlite3_free()] +** prior to assigning a new string to zErrMsg. ^After the error message +** is delivered up to the client application, the string will be automatically +** freed by tdsqlite3_free() and the zErrMsg field will be zeroed. +*/ +struct tdsqlite3_vtab { + const tdsqlite3_module *pModule; /* The module for this virtual table */ + int nRef; /* Number of open cursors */ + char *zErrMsg; /* Error message from tdsqlite3_mprintf() */ + /* Virtual table implementations will typically add additional fields */ +}; + +/* +** CAPI3REF: Virtual Table Cursor Object +** KEYWORDS: tdsqlite3_vtab_cursor {virtual table cursor} +** +** Every [virtual table module] implementation uses a subclass of the +** following structure to describe cursors that point into the +** [virtual table] and are used +** to loop through the virtual table. Cursors are created using the +** [tdsqlite3_module.xOpen | xOpen] method of the module and are destroyed +** by the [tdsqlite3_module.xClose | xClose] method. Cursors are used +** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods +** of the module. Each module implementation will define +** the content of a cursor structure to suit its own needs. +** +** This superclass exists in order to define fields of the cursor that +** are common to all implementations. +*/ +struct tdsqlite3_vtab_cursor { + tdsqlite3_vtab *pVtab; /* Virtual table of this cursor */ + /* Virtual table implementations will typically add additional fields */ +}; + +/* +** CAPI3REF: Declare The Schema Of A Virtual Table +** +** ^The [xCreate] and [xConnect] methods of a +** [virtual table module] call this interface +** to declare the format (the names and datatypes of the columns) of +** the virtual tables they implement. +*/ +SQLITE_API int tdsqlite3_declare_vtab(tdsqlite3*, const char *zSQL); + +/* +** CAPI3REF: Overload A Function For A Virtual Table +** METHOD: tdsqlite3 +** +** ^(Virtual tables can provide alternative implementations of functions +** using the [xFindFunction] method of the [virtual table module]. +** But global versions of those functions +** must exist in order to be overloaded.)^ +** +** ^(This API makes sure a global version of a function with a particular +** name and number of parameters exists. If no such function exists +** before this API is called, a new function is created.)^ ^The implementation +** of the new function always causes an exception to be thrown. So +** the new function is not good for anything by itself. Its only +** purpose is to be a placeholder function that can be overloaded +** by a [virtual table]. +*/ +SQLITE_API int tdsqlite3_overload_function(tdsqlite3*, const char *zFuncName, int nArg); + +/* +** The interface to the virtual-table mechanism defined above (back up +** to a comment remarkably similar to this one) is currently considered +** to be experimental. The interface might change in incompatible ways. +** If this is a problem for you, do not use the interface at this time. +** +** When the virtual-table mechanism stabilizes, we will declare the +** interface fixed, support it indefinitely, and remove this comment. +*/ + +/* +** CAPI3REF: A Handle To An Open BLOB +** KEYWORDS: {BLOB handle} {BLOB handles} +** +** An instance of this object represents an open BLOB on which +** [tdsqlite3_blob_open | incremental BLOB I/O] can be performed. +** ^Objects of this type are created by [tdsqlite3_blob_open()] +** and destroyed by [tdsqlite3_blob_close()]. +** ^The [tdsqlite3_blob_read()] and [tdsqlite3_blob_write()] interfaces +** can be used to read or write small subsections of the BLOB. +** ^The [tdsqlite3_blob_bytes()] interface returns the size of the BLOB in bytes. +*/ +typedef struct tdsqlite3_blob tdsqlite3_blob; + +/* +** CAPI3REF: Open A BLOB For Incremental I/O +** METHOD: tdsqlite3 +** CONSTRUCTOR: tdsqlite3_blob +** +** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located +** in row iRow, column zColumn, table zTable in database zDb; +** in other words, the same BLOB that would be selected by: +** +** 
+**     SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
+**
)^ +** +** ^(Parameter zDb is not the filename that contains the database, but +** rather the symbolic name of the database. For attached databases, this is +** the name that appears after the AS keyword in the [ATTACH] statement. +** For the main database file, the database name is "main". For TEMP +** tables, the database name is "temp".)^ +** +** ^If the flags parameter is non-zero, then the BLOB is opened for read +** and write access. ^If the flags parameter is zero, the BLOB is opened for +** read-only access. +** +** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored +** in *ppBlob. Otherwise an [error code] is returned and, unless the error +** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided +** the API is not misused, it is always safe to call [tdsqlite3_blob_close()] +** on *ppBlob after this function it returns. +** +** This function fails with SQLITE_ERROR if any of the following are true: +**
    +**
  • ^(Database zDb does not exist)^, +**
  • ^(Table zTable does not exist within database zDb)^, +**
  • ^(Table zTable is a WITHOUT ROWID table)^, +**
  • ^(Column zColumn does not exist)^, +**
  • ^(Row iRow is not present in the table)^, +**
  • ^(The specified column of row iRow contains a value that is not +** a TEXT or BLOB value)^, +**
  • ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE +** constraint and the blob is being opened for read/write access)^, +**
  • ^([foreign key constraints | Foreign key constraints] are enabled, +** column zColumn is part of a [child key] definition and the blob is +** being opened for read/write access)^. +**
+** +** ^Unless it returns SQLITE_MISUSE, this function sets the +** [database connection] error code and message accessible via +** [tdsqlite3_errcode()] and [tdsqlite3_errmsg()] and related functions. +** +** A BLOB referenced by tdsqlite3_blob_open() may be read using the +** [tdsqlite3_blob_read()] interface and modified by using +** [tdsqlite3_blob_write()]. The [BLOB handle] can be moved to a +** different row of the same table using the [tdsqlite3_blob_reopen()] +** interface. However, the column, table, or database of a [BLOB handle] +** cannot be changed after the [BLOB handle] is opened. +** +** ^(If the row that a BLOB handle points to is modified by an +** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects +** then the BLOB handle is marked as "expired". +** This is true if any column of the row is changed, even a column +** other than the one the BLOB handle is open on.)^ +** ^Calls to [tdsqlite3_blob_read()] and [tdsqlite3_blob_write()] for +** an expired BLOB handle fail with a return code of [SQLITE_ABORT]. +** ^(Changes written into a BLOB prior to the BLOB expiring are not +** rolled back by the expiration of the BLOB. Such changes will eventually +** commit if the transaction continues to completion.)^ +** +** ^Use the [tdsqlite3_blob_bytes()] interface to determine the size of +** the opened blob. ^The size of a blob may not be changed by this +** interface. Use the [UPDATE] SQL command to change the size of a +** blob. +** +** ^The [tdsqlite3_bind_zeroblob()] and [tdsqlite3_result_zeroblob()] interfaces +** and the built-in [zeroblob] SQL function may be used to create a +** zero-filled blob to read or write using the incremental-blob interface. +** +** To avoid a resource leak, every open [BLOB handle] should eventually +** be released by a call to [tdsqlite3_blob_close()]. +** +** See also: [tdsqlite3_blob_close()], +** [tdsqlite3_blob_reopen()], [tdsqlite3_blob_read()], +** [tdsqlite3_blob_bytes()], [tdsqlite3_blob_write()]. +*/ +SQLITE_API int tdsqlite3_blob_open( + tdsqlite3*, + const char *zDb, + const char *zTable, + const char *zColumn, + tdsqlite3_int64 iRow, + int flags, + tdsqlite3_blob **ppBlob +); + +/* +** CAPI3REF: Move a BLOB Handle to a New Row +** METHOD: tdsqlite3_blob +** +** ^This function is used to move an existing [BLOB handle] so that it points +** to a different row of the same database table. ^The new row is identified +** by the rowid value passed as the second argument. Only the row can be +** changed. ^The database, table and column on which the blob handle is open +** remain the same. Moving an existing [BLOB handle] to a new row is +** faster than closing the existing handle and opening a new one. +** +** ^(The new row must meet the same criteria as for [tdsqlite3_blob_open()] - +** it must exist and there must be either a blob or text value stored in +** the nominated column.)^ ^If the new row is not present in the table, or if +** it does not contain a blob or text value, or if another error occurs, an +** SQLite error code is returned and the blob handle is considered aborted. +** ^All subsequent calls to [tdsqlite3_blob_read()], [tdsqlite3_blob_write()] or +** [tdsqlite3_blob_reopen()] on an aborted blob handle immediately return +** SQLITE_ABORT. ^Calling [tdsqlite3_blob_bytes()] on an aborted blob handle +** always returns zero. +** +** ^This function sets the database handle error code and message. +*/ +SQLITE_API int tdsqlite3_blob_reopen(tdsqlite3_blob *, tdsqlite3_int64); + +/* +** CAPI3REF: Close A BLOB Handle +** DESTRUCTOR: tdsqlite3_blob +** +** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed +** unconditionally. Even if this routine returns an error code, the +** handle is still closed.)^ +** +** ^If the blob handle being closed was opened for read-write access, and if +** the database is in auto-commit mode and there are no other open read-write +** blob handles or active write statements, the current transaction is +** committed. ^If an error occurs while committing the transaction, an error +** code is returned and the transaction rolled back. +** +** Calling this function with an argument that is not a NULL pointer or an +** open blob handle results in undefined behaviour. ^Calling this routine +** with a null pointer (such as would be returned by a failed call to +** [tdsqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function +** is passed a valid open blob handle, the values returned by the +** tdsqlite3_errcode() and tdsqlite3_errmsg() functions are set before returning. +*/ +SQLITE_API int tdsqlite3_blob_close(tdsqlite3_blob *); + +/* +** CAPI3REF: Return The Size Of An Open BLOB +** METHOD: tdsqlite3_blob +** +** ^Returns the size in bytes of the BLOB accessible via the +** successfully opened [BLOB handle] in its only argument. ^The +** incremental blob I/O routines can only read or overwriting existing +** blob content; they cannot change the size of a blob. +** +** This routine only works on a [BLOB handle] which has been created +** by a prior successful call to [tdsqlite3_blob_open()] and which has not +** been closed by [tdsqlite3_blob_close()]. Passing any other pointer in +** to this routine results in undefined and probably undesirable behavior. +*/ +SQLITE_API int tdsqlite3_blob_bytes(tdsqlite3_blob *); + +/* +** CAPI3REF: Read Data From A BLOB Incrementally +** METHOD: tdsqlite3_blob +** +** ^(This function is used to read data from an open [BLOB handle] into a +** caller-supplied buffer. N bytes of data are copied into buffer Z +** from the open BLOB, starting at offset iOffset.)^ +** +** ^If offset iOffset is less than N bytes from the end of the BLOB, +** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is +** less than zero, [SQLITE_ERROR] is returned and no data is read. +** ^The size of the blob (and hence the maximum value of N+iOffset) +** can be determined using the [tdsqlite3_blob_bytes()] interface. +** +** ^An attempt to read from an expired [BLOB handle] fails with an +** error code of [SQLITE_ABORT]. +** +** ^(On success, tdsqlite3_blob_read() returns SQLITE_OK. +** Otherwise, an [error code] or an [extended error code] is returned.)^ +** +** This routine only works on a [BLOB handle] which has been created +** by a prior successful call to [tdsqlite3_blob_open()] and which has not +** been closed by [tdsqlite3_blob_close()]. Passing any other pointer in +** to this routine results in undefined and probably undesirable behavior. +** +** See also: [tdsqlite3_blob_write()]. +*/ +SQLITE_API int tdsqlite3_blob_read(tdsqlite3_blob *, void *Z, int N, int iOffset); + +/* +** CAPI3REF: Write Data Into A BLOB Incrementally +** METHOD: tdsqlite3_blob +** +** ^(This function is used to write data into an open [BLOB handle] from a +** caller-supplied buffer. N bytes of data are copied from the buffer Z +** into the open BLOB, starting at offset iOffset.)^ +** +** ^(On success, tdsqlite3_blob_write() returns SQLITE_OK. +** Otherwise, an [error code] or an [extended error code] is returned.)^ +** ^Unless SQLITE_MISUSE is returned, this function sets the +** [database connection] error code and message accessible via +** [tdsqlite3_errcode()] and [tdsqlite3_errmsg()] and related functions. +** +** ^If the [BLOB handle] passed as the first argument was not opened for +** writing (the flags parameter to [tdsqlite3_blob_open()] was zero), +** this function returns [SQLITE_READONLY]. +** +** This function may only modify the contents of the BLOB; it is +** not possible to increase the size of a BLOB using this API. +** ^If offset iOffset is less than N bytes from the end of the BLOB, +** [SQLITE_ERROR] is returned and no data is written. The size of the +** BLOB (and hence the maximum value of N+iOffset) can be determined +** using the [tdsqlite3_blob_bytes()] interface. ^If N or iOffset are less +** than zero [SQLITE_ERROR] is returned and no data is written. +** +** ^An attempt to write to an expired [BLOB handle] fails with an +** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred +** before the [BLOB handle] expired are not rolled back by the +** expiration of the handle, though of course those changes might +** have been overwritten by the statement that expired the BLOB handle +** or by other independent statements. +** +** This routine only works on a [BLOB handle] which has been created +** by a prior successful call to [tdsqlite3_blob_open()] and which has not +** been closed by [tdsqlite3_blob_close()]. Passing any other pointer in +** to this routine results in undefined and probably undesirable behavior. +** +** See also: [tdsqlite3_blob_read()]. +*/ +SQLITE_API int tdsqlite3_blob_write(tdsqlite3_blob *, const void *z, int n, int iOffset); + +/* +** CAPI3REF: Virtual File System Objects +** +** A virtual filesystem (VFS) is an [tdsqlite3_vfs] object +** that SQLite uses to interact +** with the underlying operating system. Most SQLite builds come with a +** single default VFS that is appropriate for the host computer. +** New VFSes can be registered and existing VFSes can be unregistered. +** The following interfaces are provided. +** +** ^The tdsqlite3_vfs_find() interface returns a pointer to a VFS given its name. +** ^Names are case sensitive. +** ^Names are zero-terminated UTF-8 strings. +** ^If there is no match, a NULL pointer is returned. +** ^If zVfsName is NULL then the default VFS is returned. +** +** ^New VFSes are registered with tdsqlite3_vfs_register(). +** ^Each new VFS becomes the default VFS if the makeDflt flag is set. +** ^The same VFS can be registered multiple times without injury. +** ^To make an existing VFS into the default VFS, register it again +** with the makeDflt flag set. If two different VFSes with the +** same name are registered, the behavior is undefined. If a +** VFS is registered with a name that is NULL or an empty string, +** then the behavior is undefined. +** +** ^Unregister a VFS with the tdsqlite3_vfs_unregister() interface. +** ^(If the default VFS is unregistered, another VFS is chosen as +** the default. The choice for the new VFS is arbitrary.)^ +*/ +SQLITE_API tdsqlite3_vfs *tdsqlite3_vfs_find(const char *zVfsName); +SQLITE_API int tdsqlite3_vfs_register(tdsqlite3_vfs*, int makeDflt); +SQLITE_API int tdsqlite3_vfs_unregister(tdsqlite3_vfs*); + +/* +** CAPI3REF: Mutexes +** +** The SQLite core uses these routines for thread +** synchronization. Though they are intended for internal +** use by SQLite, code that links against SQLite is +** permitted to use any of these routines. +** +** The SQLite source code contains multiple implementations +** of these mutex routines. An appropriate implementation +** is selected automatically at compile-time. The following +** implementations are available in the SQLite core: +** +**
    +**
  • SQLITE_MUTEX_PTHREADS +**
  • SQLITE_MUTEX_W32 +**
  • SQLITE_MUTEX_NOOP +**
+** +** The SQLITE_MUTEX_NOOP implementation is a set of routines +** that does no real locking and is appropriate for use in +** a single-threaded application. The SQLITE_MUTEX_PTHREADS and +** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix +** and Windows. +** +** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor +** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex +** implementation is included with the library. In this case the +** application must supply a custom mutex implementation using the +** [SQLITE_CONFIG_MUTEX] option of the tdsqlite3_config() function +** before calling tdsqlite3_initialize() or any other public tdsqlite3_ +** function that calls tdsqlite3_initialize(). +** +** ^The tdsqlite3_mutex_alloc() routine allocates a new +** mutex and returns a pointer to it. ^The tdsqlite3_mutex_alloc() +** routine returns NULL if it is unable to allocate the requested +** mutex. The argument to tdsqlite3_mutex_alloc() must one of these +** integer constants: +** +**
    +**
  • SQLITE_MUTEX_FAST +**
  • SQLITE_MUTEX_RECURSIVE +**
  • SQLITE_MUTEX_STATIC_MASTER +**
  • SQLITE_MUTEX_STATIC_MEM +**
  • SQLITE_MUTEX_STATIC_OPEN +**
  • SQLITE_MUTEX_STATIC_PRNG +**
  • SQLITE_MUTEX_STATIC_LRU +**
  • SQLITE_MUTEX_STATIC_PMEM +**
  • SQLITE_MUTEX_STATIC_APP1 +**
  • SQLITE_MUTEX_STATIC_APP2 +**
  • SQLITE_MUTEX_STATIC_APP3 +**
  • SQLITE_MUTEX_STATIC_VFS1 +**
  • SQLITE_MUTEX_STATIC_VFS2 +**
  • SQLITE_MUTEX_STATIC_VFS3 +**
+** +** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) +** cause tdsqlite3_mutex_alloc() to create +** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE +** is used but not necessarily so when SQLITE_MUTEX_FAST is used. +** The mutex implementation does not need to make a distinction +** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does +** not want to. SQLite will only request a recursive mutex in +** cases where it really needs one. If a faster non-recursive mutex +** implementation is available on the host platform, the mutex subsystem +** might return such a mutex in response to SQLITE_MUTEX_FAST. +** +** ^The other allowed parameters to tdsqlite3_mutex_alloc() (anything other +** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return +** a pointer to a static preexisting mutex. ^Nine static mutexes are +** used by the current version of SQLite. Future versions of SQLite +** may add additional static mutexes. Static mutexes are for internal +** use by SQLite only. Applications that use SQLite mutexes should +** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or +** SQLITE_MUTEX_RECURSIVE. +** +** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST +** or SQLITE_MUTEX_RECURSIVE) is used then tdsqlite3_mutex_alloc() +** returns a different mutex on every call. ^For the static +** mutex types, the same mutex is returned on every call that has +** the same type number. +** +** ^The tdsqlite3_mutex_free() routine deallocates a previously +** allocated dynamic mutex. Attempting to deallocate a static +** mutex results in undefined behavior. +** +** ^The tdsqlite3_mutex_enter() and tdsqlite3_mutex_try() routines attempt +** to enter a mutex. ^If another thread is already within the mutex, +** tdsqlite3_mutex_enter() will block and tdsqlite3_mutex_try() will return +** SQLITE_BUSY. ^The tdsqlite3_mutex_try() interface returns [SQLITE_OK] +** upon successful entry. ^(Mutexes created using +** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread. +** In such cases, the +** mutex must be exited an equal number of times before another thread +** can enter.)^ If the same thread tries to enter any mutex other +** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined. +** +** ^(Some systems (for example, Windows 95) do not support the operation +** implemented by tdsqlite3_mutex_try(). On those systems, tdsqlite3_mutex_try() +** will always return SQLITE_BUSY. The SQLite core only ever uses +** tdsqlite3_mutex_try() as an optimization so this is acceptable +** behavior.)^ +** +** ^The tdsqlite3_mutex_leave() routine exits a mutex that was +** previously entered by the same thread. The behavior +** is undefined if the mutex is not currently entered by the +** calling thread or is not currently allocated. +** +** ^If the argument to tdsqlite3_mutex_enter(), tdsqlite3_mutex_try(), or +** tdsqlite3_mutex_leave() is a NULL pointer, then all three routines +** behave as no-ops. +** +** See also: [tdsqlite3_mutex_held()] and [tdsqlite3_mutex_notheld()]. +*/ +SQLITE_API tdsqlite3_mutex *tdsqlite3_mutex_alloc(int); +SQLITE_API void tdsqlite3_mutex_free(tdsqlite3_mutex*); +SQLITE_API void tdsqlite3_mutex_enter(tdsqlite3_mutex*); +SQLITE_API int tdsqlite3_mutex_try(tdsqlite3_mutex*); +SQLITE_API void tdsqlite3_mutex_leave(tdsqlite3_mutex*); + +/* +** CAPI3REF: Mutex Methods Object +** +** An instance of this structure defines the low-level routines +** used to allocate and use mutexes. +** +** Usually, the default mutex implementations provided by SQLite are +** sufficient, however the application has the option of substituting a custom +** implementation for specialized deployments or systems for which SQLite +** does not provide a suitable implementation. In this case, the application +** creates and populates an instance of this structure to pass +** to tdsqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option. +** Additionally, an instance of this structure can be used as an +** output variable when querying the system for the current mutex +** implementation, using the [SQLITE_CONFIG_GETMUTEX] option. +** +** ^The xMutexInit method defined by this structure is invoked as +** part of system initialization by the tdsqlite3_initialize() function. +** ^The xMutexInit routine is called by SQLite exactly once for each +** effective call to [tdsqlite3_initialize()]. +** +** ^The xMutexEnd method defined by this structure is invoked as +** part of system shutdown by the tdsqlite3_shutdown() function. The +** implementation of this method is expected to release all outstanding +** resources obtained by the mutex methods implementation, especially +** those obtained by the xMutexInit method. ^The xMutexEnd() +** interface is invoked exactly once for each call to [tdsqlite3_shutdown()]. +** +** ^(The remaining seven methods defined by this structure (xMutexAlloc, +** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and +** xMutexNotheld) implement the following interfaces (respectively): +** +**
    +**
  • [tdsqlite3_mutex_alloc()]
    • +**
  • [tdsqlite3_mutex_free()]
    • +**
  • [tdsqlite3_mutex_enter()]
    • +**
  • [tdsqlite3_mutex_try()]
    • +**
  • [tdsqlite3_mutex_leave()]
    • +**
  • [tdsqlite3_mutex_held()]
    • +**
  • [tdsqlite3_mutex_notheld()]
    • +**
)^ +** +** The only difference is that the public tdsqlite3_XXX functions enumerated +** above silently ignore any invocations that pass a NULL pointer instead +** of a valid mutex handle. The implementations of the methods defined +** by this structure are not required to handle this case. The results +** of passing a NULL pointer instead of a valid mutex handle are undefined +** (i.e. it is acceptable to provide an implementation that segfaults if +** it is passed a NULL pointer). +** +** The xMutexInit() method must be threadsafe. It must be harmless to +** invoke xMutexInit() multiple times within the same process and without +** intervening calls to xMutexEnd(). Second and subsequent calls to +** xMutexInit() must be no-ops. +** +** xMutexInit() must not use SQLite memory allocation ([tdsqlite3_malloc()] +** and its associates). Similarly, xMutexAlloc() must not use SQLite memory +** allocation for a static mutex. ^However xMutexAlloc() may use SQLite +** memory allocation for a fast or recursive mutex. +** +** ^SQLite will invoke the xMutexEnd() method when [tdsqlite3_shutdown()] is +** called, but only if the prior call to xMutexInit returned SQLITE_OK. +** If xMutexInit fails in any way, it is expected to clean up after itself +** prior to returning. +*/ +typedef struct tdsqlite3_mutex_methods tdsqlite3_mutex_methods; +struct tdsqlite3_mutex_methods { + int (*xMutexInit)(void); + int (*xMutexEnd)(void); + tdsqlite3_mutex *(*xMutexAlloc)(int); + void (*xMutexFree)(tdsqlite3_mutex *); + void (*xMutexEnter)(tdsqlite3_mutex *); + int (*xMutexTry)(tdsqlite3_mutex *); + void (*xMutexLeave)(tdsqlite3_mutex *); + int (*xMutexHeld)(tdsqlite3_mutex *); + int (*xMutexNotheld)(tdsqlite3_mutex *); +}; + +/* +** CAPI3REF: Mutex Verification Routines +** +** The tdsqlite3_mutex_held() and tdsqlite3_mutex_notheld() routines +** are intended for use inside assert() statements. The SQLite core +** never uses these routines except inside an assert() and applications +** are advised to follow the lead of the core. The SQLite core only +** provides implementations for these routines when it is compiled +** with the SQLITE_DEBUG flag. External mutex implementations +** are only required to provide these routines if SQLITE_DEBUG is +** defined and if NDEBUG is not defined. +** +** These routines should return true if the mutex in their argument +** is held or not held, respectively, by the calling thread. +** +** The implementation is not required to provide versions of these +** routines that actually work. If the implementation does not provide working +** versions of these routines, it should at least provide stubs that always +** return true so that one does not get spurious assertion failures. +** +** If the argument to tdsqlite3_mutex_held() is a NULL pointer then +** the routine should return 1. This seems counter-intuitive since +** clearly the mutex cannot be held if it does not exist. But +** the reason the mutex does not exist is because the build is not +** using mutexes. And we do not want the assert() containing the +** call to tdsqlite3_mutex_held() to fail, so a non-zero return is +** the appropriate thing to do. The tdsqlite3_mutex_notheld() +** interface should also return 1 when given a NULL pointer. +*/ +#ifndef NDEBUG +SQLITE_API int tdsqlite3_mutex_held(tdsqlite3_mutex*); +SQLITE_API int tdsqlite3_mutex_notheld(tdsqlite3_mutex*); +#endif + +/* +** CAPI3REF: Mutex Types +** +** The [tdsqlite3_mutex_alloc()] interface takes a single argument +** which is one of these integer constants. +** +** The set of static mutexes may change from one SQLite release to the +** next. Applications that override the built-in mutex logic must be +** prepared to accommodate additional static mutexes. +*/ +#define SQLITE_MUTEX_FAST 0 +#define SQLITE_MUTEX_RECURSIVE 1 +#define SQLITE_MUTEX_STATIC_MASTER 2 +#define SQLITE_MUTEX_STATIC_MEM 3 /* tdsqlite3_malloc() */ +#define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */ +#define SQLITE_MUTEX_STATIC_OPEN 4 /* tdsqlite3BtreeOpen() */ +#define SQLITE_MUTEX_STATIC_PRNG 5 /* tdsqlite3_randomness() */ +#define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */ +#define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */ +#define SQLITE_MUTEX_STATIC_PMEM 7 /* tdsqlite3PageMalloc() */ +#define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */ +#define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */ +#define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */ +#define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */ +#define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */ +#define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */ + +/* +** CAPI3REF: Retrieve the mutex for a database connection +** METHOD: tdsqlite3 +** +** ^This interface returns a pointer the [tdsqlite3_mutex] object that +** serializes access to the [database connection] given in the argument +** when the [threading mode] is Serialized. +** ^If the [threading mode] is Single-thread or Multi-thread then this +** routine returns a NULL pointer. +*/ +SQLITE_API tdsqlite3_mutex *tdsqlite3_db_mutex(tdsqlite3*); + +/* +** CAPI3REF: Low-Level Control Of Database Files +** METHOD: tdsqlite3 +** KEYWORDS: {file control} +** +** ^The [tdsqlite3_file_control()] interface makes a direct call to the +** xFileControl method for the [tdsqlite3_io_methods] object associated +** with a particular database identified by the second argument. ^The +** name of the database is "main" for the main database or "temp" for the +** TEMP database, or the name that appears after the AS keyword for +** databases that are added using the [ATTACH] SQL command. +** ^A NULL pointer can be used in place of "main" to refer to the +** main database file. +** ^The third and fourth parameters to this routine +** are passed directly through to the second and third parameters of +** the xFileControl method. ^The return value of the xFileControl +** method becomes the return value of this routine. +** +** A few opcodes for [tdsqlite3_file_control()] are handled directly +** by the SQLite core and never invoke the +** tdsqlite3_io_methods.xFileControl method. +** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes +** a pointer to the underlying [tdsqlite3_file] object to be written into +** the space pointed to by the 4th parameter. The +** [SQLITE_FCNTL_JOURNAL_POINTER] works similarly except that it returns +** the [tdsqlite3_file] object associated with the journal file instead of +** the main database. The [SQLITE_FCNTL_VFS_POINTER] opcode returns +** a pointer to the underlying [tdsqlite3_vfs] object for the file. +** The [SQLITE_FCNTL_DATA_VERSION] returns the data version counter +** from the pager. +** +** ^If the second parameter (zDbName) does not match the name of any +** open database file, then SQLITE_ERROR is returned. ^This error +** code is not remembered and will not be recalled by [tdsqlite3_errcode()] +** or [tdsqlite3_errmsg()]. The underlying xFileControl method might +** also return SQLITE_ERROR. There is no way to distinguish between +** an incorrect zDbName and an SQLITE_ERROR return from the underlying +** xFileControl method. +** +** See also: [file control opcodes] +*/ +SQLITE_API int tdsqlite3_file_control(tdsqlite3*, const char *zDbName, int op, void*); + +/* +** CAPI3REF: Testing Interface +** +** ^The tdsqlite3_test_control() interface is used to read out internal +** state of SQLite and to inject faults into SQLite for testing +** purposes. ^The first parameter is an operation code that determines +** the number, meaning, and operation of all subsequent parameters. +** +** This interface is not for use by applications. It exists solely +** for verifying the correct operation of the SQLite library. Depending +** on how the SQLite library is compiled, this interface might not exist. +** +** The details of the operation codes, their meanings, the parameters +** they take, and what they do are all subject to change without notice. +** Unlike most of the SQLite API, this function is not guaranteed to +** operate consistently from one release to the next. +*/ +SQLITE_API int tdsqlite3_test_control(int op, ...); + +/* +** CAPI3REF: Testing Interface Operation Codes +** +** These constants are the valid operation code parameters used +** as the first argument to [tdsqlite3_test_control()]. +** +** These parameters and their meanings are subject to change +** without notice. These values are for testing purposes only. +** Applications should not use any of these parameters or the +** [tdsqlite3_test_control()] interface. +*/ +#define SQLITE_TESTCTRL_FIRST 5 +#define SQLITE_TESTCTRL_PRNG_SAVE 5 +#define SQLITE_TESTCTRL_PRNG_RESTORE 6 +#define SQLITE_TESTCTRL_PRNG_RESET 7 /* NOT USED */ +#define SQLITE_TESTCTRL_BITVEC_TEST 8 +#define SQLITE_TESTCTRL_FAULT_INSTALL 9 +#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10 +#define SQLITE_TESTCTRL_PENDING_BYTE 11 +#define SQLITE_TESTCTRL_ASSERT 12 +#define SQLITE_TESTCTRL_ALWAYS 13 +#define SQLITE_TESTCTRL_RESERVE 14 +#define SQLITE_TESTCTRL_OPTIMIZATIONS 15 +#define SQLITE_TESTCTRL_ISKEYWORD 16 /* NOT USED */ +#define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */ +#define SQLITE_TESTCTRL_INTERNAL_FUNCTIONS 17 +#define SQLITE_TESTCTRL_LOCALTIME_FAULT 18 +#define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */ +#define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19 +#define SQLITE_TESTCTRL_NEVER_CORRUPT 20 +#define SQLITE_TESTCTRL_VDBE_COVERAGE 21 +#define SQLITE_TESTCTRL_BYTEORDER 22 +#define SQLITE_TESTCTRL_ISINIT 23 +#define SQLITE_TESTCTRL_SORTER_MMAP 24 +#define SQLITE_TESTCTRL_IMPOSTER 25 +#define SQLITE_TESTCTRL_PARSER_COVERAGE 26 +#define SQLITE_TESTCTRL_RESULT_INTREAL 27 +#define SQLITE_TESTCTRL_PRNG_SEED 28 +#define SQLITE_TESTCTRL_EXTRA_SCHEMA_CHECKS 29 +#define SQLITE_TESTCTRL_LAST 29 /* Largest TESTCTRL */ + +/* +** CAPI3REF: SQL Keyword Checking +** +** These routines provide access to the set of SQL language keywords +** recognized by SQLite. Applications can uses these routines to determine +** whether or not a specific identifier needs to be escaped (for example, +** by enclosing in double-quotes) so as not to confuse the parser. +** +** The tdsqlite3_keyword_count() interface returns the number of distinct +** keywords understood by SQLite. +** +** The tdsqlite3_keyword_name(N,Z,L) interface finds the N-th keyword and +** makes *Z point to that keyword expressed as UTF8 and writes the number +** of bytes in the keyword into *L. The string that *Z points to is not +** zero-terminated. The tdsqlite3_keyword_name(N,Z,L) routine returns +** SQLITE_OK if N is within bounds and SQLITE_ERROR if not. If either Z +** or L are NULL or invalid pointers then calls to +** tdsqlite3_keyword_name(N,Z,L) result in undefined behavior. +** +** The tdsqlite3_keyword_check(Z,L) interface checks to see whether or not +** the L-byte UTF8 identifier that Z points to is a keyword, returning non-zero +** if it is and zero if not. +** +** The parser used by SQLite is forgiving. It is often possible to use +** a keyword as an identifier as long as such use does not result in a +** parsing ambiguity. For example, the statement +** "CREATE TABLE BEGIN(REPLACE,PRAGMA,END);" is accepted by SQLite, and +** creates a new table named "BEGIN" with three columns named +** "REPLACE", "PRAGMA", and "END". Nevertheless, best practice is to avoid +** using keywords as identifiers. Common techniques used to avoid keyword +** name collisions include: +**
    +**
  • Put all identifier names inside double-quotes. This is the official +** SQL way to escape identifier names. +**
  • Put identifier names inside [...]. This is not standard SQL, +** but it is what SQL Server does and so lots of programmers use this +** technique. +**
  • Begin every identifier with the letter "Z" as no SQL keywords start +** with "Z". +**
  • Include a digit somewhere in every identifier name. +**
+** +** Note that the number of keywords understood by SQLite can depend on +** compile-time options. For example, "VACUUM" is not a keyword if +** SQLite is compiled with the [-DSQLITE_OMIT_VACUUM] option. Also, +** new keywords may be added to future releases of SQLite. +*/ +SQLITE_API int tdsqlite3_keyword_count(void); +SQLITE_API int tdsqlite3_keyword_name(int,const char**,int*); +SQLITE_API int tdsqlite3_keyword_check(const char*,int); + +/* +** CAPI3REF: Dynamic String Object +** KEYWORDS: {dynamic string} +** +** An instance of the tdsqlite3_str object contains a dynamically-sized +** string under construction. +** +** The lifecycle of an tdsqlite3_str object is as follows: +**
    +**
  1. ^The tdsqlite3_str object is created using [tdsqlite3_str_new()]. +**
  2. ^Text is appended to the tdsqlite3_str object using various +** methods, such as [tdsqlite3_str_appendf()]. +**
  3. ^The tdsqlite3_str object is destroyed and the string it created +** is returned using the [tdsqlite3_str_finish()] interface. +**
+*/ +typedef struct tdsqlite3_str tdsqlite3_str; + +/* +** CAPI3REF: Create A New Dynamic String Object +** CONSTRUCTOR: tdsqlite3_str +** +** ^The [tdsqlite3_str_new(D)] interface allocates and initializes +** a new [tdsqlite3_str] object. To avoid memory leaks, the object returned by +** [tdsqlite3_str_new()] must be freed by a subsequent call to +** [tdsqlite3_str_finish(X)]. +** +** ^The [tdsqlite3_str_new(D)] interface always returns a pointer to a +** valid [tdsqlite3_str] object, though in the event of an out-of-memory +** error the returned object might be a special singleton that will +** silently reject new text, always return SQLITE_NOMEM from +** [tdsqlite3_str_errcode()], always return 0 for +** [tdsqlite3_str_length()], and always return NULL from +** [tdsqlite3_str_finish(X)]. It is always safe to use the value +** returned by [tdsqlite3_str_new(D)] as the tdsqlite3_str parameter +** to any of the other [tdsqlite3_str] methods. +** +** The D parameter to [tdsqlite3_str_new(D)] may be NULL. If the +** D parameter in [tdsqlite3_str_new(D)] is not NULL, then the maximum +** length of the string contained in the [tdsqlite3_str] object will be +** the value set for [tdsqlite3_limit](D,[SQLITE_LIMIT_LENGTH]) instead +** of [SQLITE_MAX_LENGTH]. +*/ +SQLITE_API tdsqlite3_str *tdsqlite3_str_new(tdsqlite3*); + +/* +** CAPI3REF: Finalize A Dynamic String +** DESTRUCTOR: tdsqlite3_str +** +** ^The [tdsqlite3_str_finish(X)] interface destroys the tdsqlite3_str object X +** and returns a pointer to a memory buffer obtained from [tdsqlite3_malloc64()] +** that contains the constructed string. The calling application should +** pass the returned value to [tdsqlite3_free()] to avoid a memory leak. +** ^The [tdsqlite3_str_finish(X)] interface may return a NULL pointer if any +** errors were encountered during construction of the string. ^The +** [tdsqlite3_str_finish(X)] interface will also return a NULL pointer if the +** string in [tdsqlite3_str] object X is zero bytes long. +*/ +SQLITE_API char *tdsqlite3_str_finish(tdsqlite3_str*); + +/* +** CAPI3REF: Add Content To A Dynamic String +** METHOD: tdsqlite3_str +** +** These interfaces add content to an tdsqlite3_str object previously obtained +** from [tdsqlite3_str_new()]. +** +** ^The [tdsqlite3_str_appendf(X,F,...)] and +** [tdsqlite3_str_vappendf(X,F,V)] interfaces uses the [built-in printf] +** functionality of SQLite to append formatted text onto the end of +** [tdsqlite3_str] object X. +** +** ^The [tdsqlite3_str_append(X,S,N)] method appends exactly N bytes from string S +** onto the end of the [tdsqlite3_str] object X. N must be non-negative. +** S must contain at least N non-zero bytes of content. To append a +** zero-terminated string in its entirety, use the [tdsqlite3_str_appendall()] +** method instead. +** +** ^The [tdsqlite3_str_appendall(X,S)] method appends the complete content of +** zero-terminated string S onto the end of [tdsqlite3_str] object X. +** +** ^The [tdsqlite3_str_appendchar(X,N,C)] method appends N copies of the +** single-byte character C onto the end of [tdsqlite3_str] object X. +** ^This method can be used, for example, to add whitespace indentation. +** +** ^The [tdsqlite3_str_reset(X)] method resets the string under construction +** inside [tdsqlite3_str] object X back to zero bytes in length. +** +** These methods do not return a result code. ^If an error occurs, that fact +** is recorded in the [tdsqlite3_str] object and can be recovered by a +** subsequent call to [tdsqlite3_str_errcode(X)]. +*/ +SQLITE_API void tdsqlite3_str_appendf(tdsqlite3_str*, const char *zFormat, ...); +SQLITE_API void tdsqlite3_str_vappendf(tdsqlite3_str*, const char *zFormat, va_list); +SQLITE_API void tdsqlite3_str_append(tdsqlite3_str*, const char *zIn, int N); +SQLITE_API void tdsqlite3_str_appendall(tdsqlite3_str*, const char *zIn); +SQLITE_API void tdsqlite3_str_appendchar(tdsqlite3_str*, int N, char C); +SQLITE_API void tdsqlite3_str_reset(tdsqlite3_str*); + +/* +** CAPI3REF: Status Of A Dynamic String +** METHOD: tdsqlite3_str +** +** These interfaces return the current status of an [tdsqlite3_str] object. +** +** ^If any prior errors have occurred while constructing the dynamic string +** in tdsqlite3_str X, then the [tdsqlite3_str_errcode(X)] method will return +** an appropriate error code. ^The [tdsqlite3_str_errcode(X)] method returns +** [SQLITE_NOMEM] following any out-of-memory error, or +** [SQLITE_TOOBIG] if the size of the dynamic string exceeds +** [SQLITE_MAX_LENGTH], or [SQLITE_OK] if there have been no errors. +** +** ^The [tdsqlite3_str_length(X)] method returns the current length, in bytes, +** of the dynamic string under construction in [tdsqlite3_str] object X. +** ^The length returned by [tdsqlite3_str_length(X)] does not include the +** zero-termination byte. +** +** ^The [tdsqlite3_str_value(X)] method returns a pointer to the current +** content of the dynamic string under construction in X. The value +** returned by [tdsqlite3_str_value(X)] is managed by the tdsqlite3_str object X +** and might be freed or altered by any subsequent method on the same +** [tdsqlite3_str] object. Applications must not used the pointer returned +** [tdsqlite3_str_value(X)] after any subsequent method call on the same +** object. ^Applications may change the content of the string returned +** by [tdsqlite3_str_value(X)] as long as they do not write into any bytes +** outside the range of 0 to [tdsqlite3_str_length(X)] and do not read or +** write any byte after any subsequent tdsqlite3_str method call. +*/ +SQLITE_API int tdsqlite3_str_errcode(tdsqlite3_str*); +SQLITE_API int tdsqlite3_str_length(tdsqlite3_str*); +SQLITE_API char *tdsqlite3_str_value(tdsqlite3_str*); + +/* +** CAPI3REF: SQLite Runtime Status +** +** ^These interfaces are used to retrieve runtime status information +** about the performance of SQLite, and optionally to reset various +** highwater marks. ^The first argument is an integer code for +** the specific parameter to measure. ^(Recognized integer codes +** are of the form [status parameters | SQLITE_STATUS_...].)^ +** ^The current value of the parameter is returned into *pCurrent. +** ^The highest recorded value is returned in *pHighwater. ^If the +** resetFlag is true, then the highest record value is reset after +** *pHighwater is written. ^(Some parameters do not record the highest +** value. For those parameters +** nothing is written into *pHighwater and the resetFlag is ignored.)^ +** ^(Other parameters record only the highwater mark and not the current +** value. For these latter parameters nothing is written into *pCurrent.)^ +** +** ^The tdsqlite3_status() and tdsqlite3_status64() routines return +** SQLITE_OK on success and a non-zero [error code] on failure. +** +** If either the current value or the highwater mark is too large to +** be represented by a 32-bit integer, then the values returned by +** tdsqlite3_status() are undefined. +** +** See also: [tdsqlite3_db_status()] +*/ +SQLITE_API int tdsqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag); +SQLITE_API int tdsqlite3_status64( + int op, + tdsqlite3_int64 *pCurrent, + tdsqlite3_int64 *pHighwater, + int resetFlag +); + + +/* +** CAPI3REF: Status Parameters +** KEYWORDS: {status parameters} +** +** These integer constants designate various run-time status parameters +** that can be returned by [tdsqlite3_status()]. +** +**
+** [[SQLITE_STATUS_MEMORY_USED]] ^(
SQLITE_STATUS_MEMORY_USED
+**
This parameter is the current amount of memory checked out +** using [tdsqlite3_malloc()], either directly or indirectly. The +** figure includes calls made to [tdsqlite3_malloc()] by the application +** and internal memory usage by the SQLite library. Auxiliary page-cache +** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in +** this parameter. The amount returned is the sum of the allocation +** sizes as reported by the xSize method in [tdsqlite3_mem_methods].
)^ +** +** [[SQLITE_STATUS_MALLOC_SIZE]] ^(
SQLITE_STATUS_MALLOC_SIZE
+**
This parameter records the largest memory allocation request +** handed to [tdsqlite3_malloc()] or [tdsqlite3_realloc()] (or their +** internal equivalents). Only the value returned in the +** *pHighwater parameter to [tdsqlite3_status()] is of interest. +** The value written into the *pCurrent parameter is undefined.
)^ +** +** [[SQLITE_STATUS_MALLOC_COUNT]] ^(
SQLITE_STATUS_MALLOC_COUNT
+**
This parameter records the number of separate memory allocations +** currently checked out.
)^ +** +** [[SQLITE_STATUS_PAGECACHE_USED]] ^(
SQLITE_STATUS_PAGECACHE_USED
+**
This parameter returns the number of pages used out of the +** [pagecache memory allocator] that was configured using +** [SQLITE_CONFIG_PAGECACHE]. The +** value returned is in pages, not in bytes.
)^ +** +** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] +** ^(
SQLITE_STATUS_PAGECACHE_OVERFLOW
+**
This parameter returns the number of bytes of page cache +** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE] +** buffer and where forced to overflow to [tdsqlite3_malloc()]. The +** returned value includes allocations that overflowed because they +** where too large (they were larger than the "sz" parameter to +** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because +** no space was left in the page cache.
)^ +** +** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(
SQLITE_STATUS_PAGECACHE_SIZE
+**
This parameter records the largest memory allocation request +** handed to the [pagecache memory allocator]. Only the value returned in the +** *pHighwater parameter to [tdsqlite3_status()] is of interest. +** The value written into the *pCurrent parameter is undefined.
)^ +** +** [[SQLITE_STATUS_SCRATCH_USED]]
SQLITE_STATUS_SCRATCH_USED
+**
No longer used.
+** +** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(
SQLITE_STATUS_SCRATCH_OVERFLOW
+**
No longer used.
+** +** [[SQLITE_STATUS_SCRATCH_SIZE]]
SQLITE_STATUS_SCRATCH_SIZE
+**
No longer used.
+** +** [[SQLITE_STATUS_PARSER_STACK]] ^(
SQLITE_STATUS_PARSER_STACK
+**
The *pHighwater parameter records the deepest parser stack. +** The *pCurrent value is undefined. The *pHighwater value is only +** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].
)^ +**
+** +** New status parameters may be added from time to time. +*/ +#define SQLITE_STATUS_MEMORY_USED 0 +#define SQLITE_STATUS_PAGECACHE_USED 1 +#define SQLITE_STATUS_PAGECACHE_OVERFLOW 2 +#define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */ +#define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */ +#define SQLITE_STATUS_MALLOC_SIZE 5 +#define SQLITE_STATUS_PARSER_STACK 6 +#define SQLITE_STATUS_PAGECACHE_SIZE 7 +#define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */ +#define SQLITE_STATUS_MALLOC_COUNT 9 + +/* +** CAPI3REF: Database Connection Status +** METHOD: tdsqlite3 +** +** ^This interface is used to retrieve runtime status information +** about a single [database connection]. ^The first argument is the +** database connection object to be interrogated. ^The second argument +** is an integer constant, taken from the set of +** [SQLITE_DBSTATUS options], that +** determines the parameter to interrogate. The set of +** [SQLITE_DBSTATUS options] is likely +** to grow in future releases of SQLite. +** +** ^The current value of the requested parameter is written into *pCur +** and the highest instantaneous value is written into *pHiwtr. ^If +** the resetFlg is true, then the highest instantaneous value is +** reset back down to the current value. +** +** ^The tdsqlite3_db_status() routine returns SQLITE_OK on success and a +** non-zero [error code] on failure. +** +** See also: [tdsqlite3_status()] and [tdsqlite3_stmt_status()]. +*/ +SQLITE_API int tdsqlite3_db_status(tdsqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg); + +/* +** CAPI3REF: Status Parameters for database connections +** KEYWORDS: {SQLITE_DBSTATUS options} +** +** These constants are the available integer "verbs" that can be passed as +** the second argument to the [tdsqlite3_db_status()] interface. +** +** New verbs may be added in future releases of SQLite. Existing verbs +** might be discontinued. Applications should check the return code from +** [tdsqlite3_db_status()] to make sure that the call worked. +** The [tdsqlite3_db_status()] interface will return a non-zero error code +** if a discontinued or unsupported verb is invoked. +** +**
+** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(
SQLITE_DBSTATUS_LOOKASIDE_USED
+**
This parameter returns the number of lookaside memory slots currently +** checked out.
)^ +** +** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(
SQLITE_DBSTATUS_LOOKASIDE_HIT
+**
This parameter returns the number of malloc attempts that were +** satisfied using lookaside memory. Only the high-water value is meaningful; +** the current value is always zero.)^ +** +** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]] +** ^(
SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE
+**
This parameter returns the number malloc attempts that might have +** been satisfied using lookaside memory but failed due to the amount of +** memory requested being larger than the lookaside slot size. +** Only the high-water value is meaningful; +** the current value is always zero.)^ +** +** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]] +** ^(
SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL
+**
This parameter returns the number malloc attempts that might have +** been satisfied using lookaside memory but failed due to all lookaside +** memory already being in use. +** Only the high-water value is meaningful; +** the current value is always zero.)^ +** +** [[SQLITE_DBSTATUS_CACHE_USED]] ^(
SQLITE_DBSTATUS_CACHE_USED
+**
This parameter returns the approximate number of bytes of heap +** memory used by all pager caches associated with the database connection.)^ +** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0. +** +** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]] +** ^(
SQLITE_DBSTATUS_CACHE_USED_SHARED
+**
This parameter is similar to DBSTATUS_CACHE_USED, except that if a +** pager cache is shared between two or more connections the bytes of heap +** memory used by that pager cache is divided evenly between the attached +** connections.)^ In other words, if none of the pager caches associated +** with the database connection are shared, this request returns the same +** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are +** shared, the value returned by this call will be smaller than that returned +** by DBSTATUS_CACHE_USED. ^The highwater mark associated with +** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0. +** +** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(
SQLITE_DBSTATUS_SCHEMA_USED
+**
This parameter returns the approximate number of bytes of heap +** memory used to store the schema for all databases associated +** with the connection - main, temp, and any [ATTACH]-ed databases.)^ +** ^The full amount of memory used by the schemas is reported, even if the +** schema memory is shared with other database connections due to +** [shared cache mode] being enabled. +** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0. +** +** [[SQLITE_DBSTATUS_STMT_USED]] ^(
SQLITE_DBSTATUS_STMT_USED
+**
This parameter returns the approximate number of bytes of heap +** and lookaside memory used by all prepared statements associated with +** the database connection.)^ +** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0. +**
+** +** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(
SQLITE_DBSTATUS_CACHE_HIT
+**
This parameter returns the number of pager cache hits that have +** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT +** is always 0. +**
+** +** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(
SQLITE_DBSTATUS_CACHE_MISS
+**
This parameter returns the number of pager cache misses that have +** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS +** is always 0. +**
+** +** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(
SQLITE_DBSTATUS_CACHE_WRITE
+**
This parameter returns the number of dirty cache entries that have +** been written to disk. Specifically, the number of pages written to the +** wal file in wal mode databases, or the number of pages written to the +** database file in rollback mode databases. Any pages written as part of +** transaction rollback or database recovery operations are not included. +** If an IO or other error occurs while writing a page to disk, the effect +** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The +** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0. +**
+** +** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(
SQLITE_DBSTATUS_CACHE_SPILL
+**
This parameter returns the number of dirty cache entries that have +** been written to disk in the middle of a transaction due to the page +** cache overflowing. Transactions are more efficient if they are written +** to disk all at once. When pages spill mid-transaction, that introduces +** additional overhead. This parameter can be used help identify +** inefficiencies that can be resolved by increasing the cache size. +**
+** +** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(
SQLITE_DBSTATUS_DEFERRED_FKS
+**
This parameter returns zero for the current value if and only if +** all foreign key constraints (deferred or immediate) have been +** resolved.)^ ^The highwater mark is always 0. +**
+**
+*/ +#define SQLITE_DBSTATUS_LOOKASIDE_USED 0 +#define SQLITE_DBSTATUS_CACHE_USED 1 +#define SQLITE_DBSTATUS_SCHEMA_USED 2 +#define SQLITE_DBSTATUS_STMT_USED 3 +#define SQLITE_DBSTATUS_LOOKASIDE_HIT 4 +#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5 +#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6 +#define SQLITE_DBSTATUS_CACHE_HIT 7 +#define SQLITE_DBSTATUS_CACHE_MISS 8 +#define SQLITE_DBSTATUS_CACHE_WRITE 9 +#define SQLITE_DBSTATUS_DEFERRED_FKS 10 +#define SQLITE_DBSTATUS_CACHE_USED_SHARED 11 +#define SQLITE_DBSTATUS_CACHE_SPILL 12 +#define SQLITE_DBSTATUS_MAX 12 /* Largest defined DBSTATUS */ + + +/* +** CAPI3REF: Prepared Statement Status +** METHOD: tdsqlite3_stmt +** +** ^(Each prepared statement maintains various +** [SQLITE_STMTSTATUS counters] that measure the number +** of times it has performed specific operations.)^ These counters can +** be used to monitor the performance characteristics of the prepared +** statements. For example, if the number of table steps greatly exceeds +** the number of table searches or result rows, that would tend to indicate +** that the prepared statement is using a full table scan rather than +** an index. +** +** ^(This interface is used to retrieve and reset counter values from +** a [prepared statement]. The first argument is the prepared statement +** object to be interrogated. The second argument +** is an integer code for a specific [SQLITE_STMTSTATUS counter] +** to be interrogated.)^ +** ^The current value of the requested counter is returned. +** ^If the resetFlg is true, then the counter is reset to zero after this +** interface call returns. +** +** See also: [tdsqlite3_status()] and [tdsqlite3_db_status()]. +*/ +SQLITE_API int tdsqlite3_stmt_status(tdsqlite3_stmt*, int op,int resetFlg); + +/* +** CAPI3REF: Status Parameters for prepared statements +** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters} +** +** These preprocessor macros define integer codes that name counter +** values associated with the [tdsqlite3_stmt_status()] interface. +** The meanings of the various counters are as follows: +** +**
+** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]]
SQLITE_STMTSTATUS_FULLSCAN_STEP
+**
^This is the number of times that SQLite has stepped forward in +** a table as part of a full table scan. Large numbers for this counter +** may indicate opportunities for performance improvement through +** careful use of indices.
+** +** [[SQLITE_STMTSTATUS_SORT]]
SQLITE_STMTSTATUS_SORT
+**
^This is the number of sort operations that have occurred. +** A non-zero value in this counter may indicate an opportunity to +** improvement performance through careful use of indices.
+** +** [[SQLITE_STMTSTATUS_AUTOINDEX]]
SQLITE_STMTSTATUS_AUTOINDEX
+**
^This is the number of rows inserted into transient indices that +** were created automatically in order to help joins run faster. +** A non-zero value in this counter may indicate an opportunity to +** improvement performance by adding permanent indices that do not +** need to be reinitialized each time the statement is run.
+** +** [[SQLITE_STMTSTATUS_VM_STEP]]
SQLITE_STMTSTATUS_VM_STEP
+**
^This is the number of virtual machine operations executed +** by the prepared statement if that number is less than or equal +** to 2147483647. The number of virtual machine operations can be +** used as a proxy for the total work done by the prepared statement. +** If the number of virtual machine operations exceeds 2147483647 +** then the value returned by this statement status code is undefined. +** +** [[SQLITE_STMTSTATUS_REPREPARE]]
SQLITE_STMTSTATUS_REPREPARE
+**
^This is the number of times that the prepare statement has been +** automatically regenerated due to schema changes or changes to +** [bound parameters] that might affect the query plan. +** +** [[SQLITE_STMTSTATUS_RUN]]
SQLITE_STMTSTATUS_RUN
+**
^This is the number of times that the prepared statement has +** been run. A single "run" for the purposes of this counter is one +** or more calls to [tdsqlite3_step()] followed by a call to [tdsqlite3_reset()]. +** The counter is incremented on the first [tdsqlite3_step()] call of each +** cycle. +** +** [[SQLITE_STMTSTATUS_MEMUSED]]
SQLITE_STMTSTATUS_MEMUSED
+**
^This is the approximate number of bytes of heap memory +** used to store the prepared statement. ^This value is not actually +** a counter, and so the resetFlg parameter to tdsqlite3_stmt_status() +** is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED. +**
+**
+*/ +#define SQLITE_STMTSTATUS_FULLSCAN_STEP 1 +#define SQLITE_STMTSTATUS_SORT 2 +#define SQLITE_STMTSTATUS_AUTOINDEX 3 +#define SQLITE_STMTSTATUS_VM_STEP 4 +#define SQLITE_STMTSTATUS_REPREPARE 5 +#define SQLITE_STMTSTATUS_RUN 6 +#define SQLITE_STMTSTATUS_MEMUSED 99 + +/* +** CAPI3REF: Custom Page Cache Object +** +** The tdsqlite3_pcache type is opaque. It is implemented by +** the pluggable module. The SQLite core has no knowledge of +** its size or internal structure and never deals with the +** tdsqlite3_pcache object except by holding and passing pointers +** to the object. +** +** See [tdsqlite3_pcache_methods2] for additional information. +*/ +typedef struct tdsqlite3_pcache tdsqlite3_pcache; + +/* +** CAPI3REF: Custom Page Cache Object +** +** The tdsqlite3_pcache_page object represents a single page in the +** page cache. The page cache will allocate instances of this +** object. Various methods of the page cache use pointers to instances +** of this object as parameters or as their return value. +** +** See [tdsqlite3_pcache_methods2] for additional information. +*/ +typedef struct tdsqlite3_pcache_page tdsqlite3_pcache_page; +struct tdsqlite3_pcache_page { + void *pBuf; /* The content of the page */ + void *pExtra; /* Extra information associated with the page */ +}; + +/* +** CAPI3REF: Application Defined Page Cache. +** KEYWORDS: {page cache} +** +** ^(The [tdsqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can +** register an alternative page cache implementation by passing in an +** instance of the tdsqlite3_pcache_methods2 structure.)^ +** In many applications, most of the heap memory allocated by +** SQLite is used for the page cache. +** By implementing a +** custom page cache using this API, an application can better control +** the amount of memory consumed by SQLite, the way in which +** that memory is allocated and released, and the policies used to +** determine exactly which parts of a database file are cached and for +** how long. +** +** The alternative page cache mechanism is an +** extreme measure that is only needed by the most demanding applications. +** The built-in page cache is recommended for most uses. +** +** ^(The contents of the tdsqlite3_pcache_methods2 structure are copied to an +** internal buffer by SQLite within the call to [tdsqlite3_config]. Hence +** the application may discard the parameter after the call to +** [tdsqlite3_config()] returns.)^ +** +** [[the xInit() page cache method]] +** ^(The xInit() method is called once for each effective +** call to [tdsqlite3_initialize()])^ +** (usually only once during the lifetime of the process). ^(The xInit() +** method is passed a copy of the tdsqlite3_pcache_methods2.pArg value.)^ +** The intent of the xInit() method is to set up global data structures +** required by the custom page cache implementation. +** ^(If the xInit() method is NULL, then the +** built-in default page cache is used instead of the application defined +** page cache.)^ +** +** [[the xShutdown() page cache method]] +** ^The xShutdown() method is called by [tdsqlite3_shutdown()]. +** It can be used to clean up +** any outstanding resources before process shutdown, if required. +** ^The xShutdown() method may be NULL. +** +** ^SQLite automatically serializes calls to the xInit method, +** so the xInit method need not be threadsafe. ^The +** xShutdown method is only called from [tdsqlite3_shutdown()] so it does +** not need to be threadsafe either. All other methods must be threadsafe +** in multithreaded applications. +** +** ^SQLite will never invoke xInit() more than once without an intervening +** call to xShutdown(). +** +** [[the xCreate() page cache methods]] +** ^SQLite invokes the xCreate() method to construct a new cache instance. +** SQLite will typically create one cache instance for each open database file, +** though this is not guaranteed. ^The +** first parameter, szPage, is the size in bytes of the pages that must +** be allocated by the cache. ^szPage will always a power of two. ^The +** second parameter szExtra is a number of bytes of extra storage +** associated with each page cache entry. ^The szExtra parameter will +** a number less than 250. SQLite will use the +** extra szExtra bytes on each page to store metadata about the underlying +** database page on disk. The value passed into szExtra depends +** on the SQLite version, the target platform, and how SQLite was compiled. +** ^The third argument to xCreate(), bPurgeable, is true if the cache being +** created will be used to cache database pages of a file stored on disk, or +** false if it is used for an in-memory database. The cache implementation +** does not have to do anything special based with the value of bPurgeable; +** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will +** never invoke xUnpin() except to deliberately delete a page. +** ^In other words, calls to xUnpin() on a cache with bPurgeable set to +** false will always have the "discard" flag set to true. +** ^Hence, a cache created with bPurgeable false will +** never contain any unpinned pages. +** +** [[the xCachesize() page cache method]] +** ^(The xCachesize() method may be called at any time by SQLite to set the +** suggested maximum cache-size (number of pages stored by) the cache +** instance passed as the first argument. This is the value configured using +** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable +** parameter, the implementation is not required to do anything with this +** value; it is advisory only. +** +** [[the xPagecount() page cache methods]] +** The xPagecount() method must return the number of pages currently +** stored in the cache, both pinned and unpinned. +** +** [[the xFetch() page cache methods]] +** The xFetch() method locates a page in the cache and returns a pointer to +** an tdsqlite3_pcache_page object associated with that page, or a NULL pointer. +** The pBuf element of the returned tdsqlite3_pcache_page object will be a +** pointer to a buffer of szPage bytes used to store the content of a +** single database page. The pExtra element of tdsqlite3_pcache_page will be +** a pointer to the szExtra bytes of extra storage that SQLite has requested +** for each entry in the page cache. +** +** The page to be fetched is determined by the key. ^The minimum key value +** is 1. After it has been retrieved using xFetch, the page is considered +** to be "pinned". +** +** If the requested page is already in the page cache, then the page cache +** implementation must return a pointer to the page buffer with its content +** intact. If the requested page is not already in the cache, then the +** cache implementation should use the value of the createFlag +** parameter to help it determined what action to take: +** +** +**
createFlag Behavior when page is not already in cache +**
0 Do not allocate a new page. Return NULL. +**
1 Allocate a new page if it easy and convenient to do so. +** Otherwise return NULL. +**
2 Make every effort to allocate a new page. Only return +** NULL if allocating a new page is effectively impossible. +**
+** +** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite +** will only use a createFlag of 2 after a prior call with a createFlag of 1 +** failed.)^ In between the xFetch() calls, SQLite may +** attempt to unpin one or more cache pages by spilling the content of +** pinned pages to disk and synching the operating system disk cache. +** +** [[the xUnpin() page cache method]] +** ^xUnpin() is called by SQLite with a pointer to a currently pinned page +** as its second argument. If the third parameter, discard, is non-zero, +** then the page must be evicted from the cache. +** ^If the discard parameter is +** zero, then the page may be discarded or retained at the discretion of +** page cache implementation. ^The page cache implementation +** may choose to evict unpinned pages at any time. +** +** The cache must not perform any reference counting. A single +** call to xUnpin() unpins the page regardless of the number of prior calls +** to xFetch(). +** +** [[the xRekey() page cache methods]] +** The xRekey() method is used to change the key value associated with the +** page passed as the second argument. If the cache +** previously contains an entry associated with newKey, it must be +** discarded. ^Any prior cache entry associated with newKey is guaranteed not +** to be pinned. +** +** When SQLite calls the xTruncate() method, the cache must discard all +** existing cache entries with page numbers (keys) greater than or equal +** to the value of the iLimit parameter passed to xTruncate(). If any +** of these pages are pinned, they are implicitly unpinned, meaning that +** they can be safely discarded. +** +** [[the xDestroy() page cache method]] +** ^The xDestroy() method is used to delete a cache allocated by xCreate(). +** All resources associated with the specified cache should be freed. ^After +** calling the xDestroy() method, SQLite considers the [tdsqlite3_pcache*] +** handle invalid, and will not use it with any other tdsqlite3_pcache_methods2 +** functions. +** +** [[the xShrink() page cache method]] +** ^SQLite invokes the xShrink() method when it wants the page cache to +** free up as much of heap memory as possible. The page cache implementation +** is not obligated to free any memory, but well-behaved implementations should +** do their best. +*/ +typedef struct tdsqlite3_pcache_methods2 tdsqlite3_pcache_methods2; +struct tdsqlite3_pcache_methods2 { + int iVersion; + void *pArg; + int (*xInit)(void*); + void (*xShutdown)(void*); + tdsqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable); + void (*xCachesize)(tdsqlite3_pcache*, int nCachesize); + int (*xPagecount)(tdsqlite3_pcache*); + tdsqlite3_pcache_page *(*xFetch)(tdsqlite3_pcache*, unsigned key, int createFlag); + void (*xUnpin)(tdsqlite3_pcache*, tdsqlite3_pcache_page*, int discard); + void (*xRekey)(tdsqlite3_pcache*, tdsqlite3_pcache_page*, + unsigned oldKey, unsigned newKey); + void (*xTruncate)(tdsqlite3_pcache*, unsigned iLimit); + void (*xDestroy)(tdsqlite3_pcache*); + void (*xShrink)(tdsqlite3_pcache*); +}; + +/* +** This is the obsolete pcache_methods object that has now been replaced +** by tdsqlite3_pcache_methods2. This object is not used by SQLite. It is +** retained in the header file for backwards compatibility only. +*/ +typedef struct tdsqlite3_pcache_methods tdsqlite3_pcache_methods; +struct tdsqlite3_pcache_methods { + void *pArg; + int (*xInit)(void*); + void (*xShutdown)(void*); + tdsqlite3_pcache *(*xCreate)(int szPage, int bPurgeable); + void (*xCachesize)(tdsqlite3_pcache*, int nCachesize); + int (*xPagecount)(tdsqlite3_pcache*); + void *(*xFetch)(tdsqlite3_pcache*, unsigned key, int createFlag); + void (*xUnpin)(tdsqlite3_pcache*, void*, int discard); + void (*xRekey)(tdsqlite3_pcache*, void*, unsigned oldKey, unsigned newKey); + void (*xTruncate)(tdsqlite3_pcache*, unsigned iLimit); + void (*xDestroy)(tdsqlite3_pcache*); +}; + + +/* +** CAPI3REF: Online Backup Object +** +** The tdsqlite3_backup object records state information about an ongoing +** online backup operation. ^The tdsqlite3_backup object is created by +** a call to [tdsqlite3_backup_init()] and is destroyed by a call to +** [tdsqlite3_backup_finish()]. +** +** See Also: [Using the SQLite Online Backup API] +*/ +typedef struct tdsqlite3_backup tdsqlite3_backup; + +/* +** CAPI3REF: Online Backup API. +** +** The backup API copies the content of one database into another. +** It is useful either for creating backups of databases or +** for copying in-memory databases to or from persistent files. +** +** See Also: [Using the SQLite Online Backup API] +** +** ^SQLite holds a write transaction open on the destination database file +** for the duration of the backup operation. +** ^The source database is read-locked only while it is being read; +** it is not locked continuously for the entire backup operation. +** ^Thus, the backup may be performed on a live source database without +** preventing other database connections from +** reading or writing to the source database while the backup is underway. +** +** ^(To perform a backup operation: +**
    +**
  1. tdsqlite3_backup_init() is called once to initialize the +** backup, +**
  2. tdsqlite3_backup_step() is called one or more times to transfer +** the data between the two databases, and finally +**
  3. tdsqlite3_backup_finish() is called to release all resources +** associated with the backup operation. +**
)^ +** There should be exactly one call to tdsqlite3_backup_finish() for each +** successful call to tdsqlite3_backup_init(). +** +** [[tdsqlite3_backup_init()]] tdsqlite3_backup_init() +** +** ^The D and N arguments to tdsqlite3_backup_init(D,N,S,M) are the +** [database connection] associated with the destination database +** and the database name, respectively. +** ^The database name is "main" for the main database, "temp" for the +** temporary database, or the name specified after the AS keyword in +** an [ATTACH] statement for an attached database. +** ^The S and M arguments passed to +** tdsqlite3_backup_init(D,N,S,M) identify the [database connection] +** and database name of the source database, respectively. +** ^The source and destination [database connections] (parameters S and D) +** must be different or else tdsqlite3_backup_init(D,N,S,M) will fail with +** an error. +** +** ^A call to tdsqlite3_backup_init() will fail, returning NULL, if +** there is already a read or read-write transaction open on the +** destination database. +** +** ^If an error occurs within tdsqlite3_backup_init(D,N,S,M), then NULL is +** returned and an error code and error message are stored in the +** destination [database connection] D. +** ^The error code and message for the failed call to tdsqlite3_backup_init() +** can be retrieved using the [tdsqlite3_errcode()], [tdsqlite3_errmsg()], and/or +** [tdsqlite3_errmsg16()] functions. +** ^A successful call to tdsqlite3_backup_init() returns a pointer to an +** [tdsqlite3_backup] object. +** ^The [tdsqlite3_backup] object may be used with the tdsqlite3_backup_step() and +** tdsqlite3_backup_finish() functions to perform the specified backup +** operation. +** +** [[tdsqlite3_backup_step()]] tdsqlite3_backup_step() +** +** ^Function tdsqlite3_backup_step(B,N) will copy up to N pages between +** the source and destination databases specified by [tdsqlite3_backup] object B. +** ^If N is negative, all remaining source pages are copied. +** ^If tdsqlite3_backup_step(B,N) successfully copies N pages and there +** are still more pages to be copied, then the function returns [SQLITE_OK]. +** ^If tdsqlite3_backup_step(B,N) successfully finishes copying all pages +** from source to destination, then it returns [SQLITE_DONE]. +** ^If an error occurs while running tdsqlite3_backup_step(B,N), +** then an [error code] is returned. ^As well as [SQLITE_OK] and +** [SQLITE_DONE], a call to tdsqlite3_backup_step() may return [SQLITE_READONLY], +** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an +** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code. +** +** ^(The tdsqlite3_backup_step() might return [SQLITE_READONLY] if +**
    +**
  1. the destination database was opened read-only, or +**
  2. the destination database is using write-ahead-log journaling +** and the destination and source page sizes differ, or +**
  3. the destination database is an in-memory database and the +** destination and source page sizes differ. +**
)^ +** +** ^If tdsqlite3_backup_step() cannot obtain a required file-system lock, then +** the [tdsqlite3_busy_handler | busy-handler function] +** is invoked (if one is specified). ^If the +** busy-handler returns non-zero before the lock is available, then +** [SQLITE_BUSY] is returned to the caller. ^In this case the call to +** tdsqlite3_backup_step() can be retried later. ^If the source +** [database connection] +** is being used to write to the source database when tdsqlite3_backup_step() +** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this +** case the call to tdsqlite3_backup_step() can be retried later on. ^(If +** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or +** [SQLITE_READONLY] is returned, then +** there is no point in retrying the call to tdsqlite3_backup_step(). These +** errors are considered fatal.)^ The application must accept +** that the backup operation has failed and pass the backup operation handle +** to the tdsqlite3_backup_finish() to release associated resources. +** +** ^The first call to tdsqlite3_backup_step() obtains an exclusive lock +** on the destination file. ^The exclusive lock is not released until either +** tdsqlite3_backup_finish() is called or the backup operation is complete +** and tdsqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to +** tdsqlite3_backup_step() obtains a [shared lock] on the source database that +** lasts for the duration of the tdsqlite3_backup_step() call. +** ^Because the source database is not locked between calls to +** tdsqlite3_backup_step(), the source database may be modified mid-way +** through the backup process. ^If the source database is modified by an +** external process or via a database connection other than the one being +** used by the backup operation, then the backup will be automatically +** restarted by the next call to tdsqlite3_backup_step(). ^If the source +** database is modified by the using the same database connection as is used +** by the backup operation, then the backup database is automatically +** updated at the same time. +** +** [[tdsqlite3_backup_finish()]] tdsqlite3_backup_finish() +** +** When tdsqlite3_backup_step() has returned [SQLITE_DONE], or when the +** application wishes to abandon the backup operation, the application +** should destroy the [tdsqlite3_backup] by passing it to tdsqlite3_backup_finish(). +** ^The tdsqlite3_backup_finish() interfaces releases all +** resources associated with the [tdsqlite3_backup] object. +** ^If tdsqlite3_backup_step() has not yet returned [SQLITE_DONE], then any +** active write-transaction on the destination database is rolled back. +** The [tdsqlite3_backup] object is invalid +** and may not be used following a call to tdsqlite3_backup_finish(). +** +** ^The value returned by tdsqlite3_backup_finish is [SQLITE_OK] if no +** tdsqlite3_backup_step() errors occurred, regardless or whether or not +** tdsqlite3_backup_step() completed. +** ^If an out-of-memory condition or IO error occurred during any prior +** tdsqlite3_backup_step() call on the same [tdsqlite3_backup] object, then +** tdsqlite3_backup_finish() returns the corresponding [error code]. +** +** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from tdsqlite3_backup_step() +** is not a permanent error and does not affect the return value of +** tdsqlite3_backup_finish(). +** +** [[tdsqlite3_backup_remaining()]] [[tdsqlite3_backup_pagecount()]] +** tdsqlite3_backup_remaining() and tdsqlite3_backup_pagecount() +** +** ^The tdsqlite3_backup_remaining() routine returns the number of pages still +** to be backed up at the conclusion of the most recent tdsqlite3_backup_step(). +** ^The tdsqlite3_backup_pagecount() routine returns the total number of pages +** in the source database at the conclusion of the most recent +** tdsqlite3_backup_step(). +** ^(The values returned by these functions are only updated by +** tdsqlite3_backup_step(). If the source database is modified in a way that +** changes the size of the source database or the number of pages remaining, +** those changes are not reflected in the output of tdsqlite3_backup_pagecount() +** and tdsqlite3_backup_remaining() until after the next +** tdsqlite3_backup_step().)^ +** +** Concurrent Usage of Database Handles +** +** ^The source [database connection] may be used by the application for other +** purposes while a backup operation is underway or being initialized. +** ^If SQLite is compiled and configured to support threadsafe database +** connections, then the source database connection may be used concurrently +** from within other threads. +** +** However, the application must guarantee that the destination +** [database connection] is not passed to any other API (by any thread) after +** tdsqlite3_backup_init() is called and before the corresponding call to +** tdsqlite3_backup_finish(). SQLite does not currently check to see +** if the application incorrectly accesses the destination [database connection] +** and so no error code is reported, but the operations may malfunction +** nevertheless. Use of the destination database connection while a +** backup is in progress might also also cause a mutex deadlock. +** +** If running in [shared cache mode], the application must +** guarantee that the shared cache used by the destination database +** is not accessed while the backup is running. In practice this means +** that the application must guarantee that the disk file being +** backed up to is not accessed by any connection within the process, +** not just the specific connection that was passed to tdsqlite3_backup_init(). +** +** The [tdsqlite3_backup] object itself is partially threadsafe. Multiple +** threads may safely make multiple concurrent calls to tdsqlite3_backup_step(). +** However, the tdsqlite3_backup_remaining() and tdsqlite3_backup_pagecount() +** APIs are not strictly speaking threadsafe. If they are invoked at the +** same time as another thread is invoking tdsqlite3_backup_step() it is +** possible that they return invalid values. +*/ +SQLITE_API tdsqlite3_backup *tdsqlite3_backup_init( + tdsqlite3 *pDest, /* Destination database handle */ + const char *zDestName, /* Destination database name */ + tdsqlite3 *pSource, /* Source database handle */ + const char *zSourceName /* Source database name */ +); +SQLITE_API int tdsqlite3_backup_step(tdsqlite3_backup *p, int nPage); +SQLITE_API int tdsqlite3_backup_finish(tdsqlite3_backup *p); +SQLITE_API int tdsqlite3_backup_remaining(tdsqlite3_backup *p); +SQLITE_API int tdsqlite3_backup_pagecount(tdsqlite3_backup *p); + +/* +** CAPI3REF: Unlock Notification +** METHOD: tdsqlite3 +** +** ^When running in shared-cache mode, a database operation may fail with +** an [SQLITE_LOCKED] error if the required locks on the shared-cache or +** individual tables within the shared-cache cannot be obtained. See +** [SQLite Shared-Cache Mode] for a description of shared-cache locking. +** ^This API may be used to register a callback that SQLite will invoke +** when the connection currently holding the required lock relinquishes it. +** ^This API is only available if the library was compiled with the +** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined. +** +** See Also: [Using the SQLite Unlock Notification Feature]. +** +** ^Shared-cache locks are released when a database connection concludes +** its current transaction, either by committing it or rolling it back. +** +** ^When a connection (known as the blocked connection) fails to obtain a +** shared-cache lock and SQLITE_LOCKED is returned to the caller, the +** identity of the database connection (the blocking connection) that +** has locked the required resource is stored internally. ^After an +** application receives an SQLITE_LOCKED error, it may call the +** tdsqlite3_unlock_notify() method with the blocked connection handle as +** the first argument to register for a callback that will be invoked +** when the blocking connections current transaction is concluded. ^The +** callback is invoked from within the [tdsqlite3_step] or [tdsqlite3_close] +** call that concludes the blocking connection's transaction. +** +** ^(If tdsqlite3_unlock_notify() is called in a multi-threaded application, +** there is a chance that the blocking connection will have already +** concluded its transaction by the time tdsqlite3_unlock_notify() is invoked. +** If this happens, then the specified callback is invoked immediately, +** from within the call to tdsqlite3_unlock_notify().)^ +** +** ^If the blocked connection is attempting to obtain a write-lock on a +** shared-cache table, and more than one other connection currently holds +** a read-lock on the same table, then SQLite arbitrarily selects one of +** the other connections to use as the blocking connection. +** +** ^(There may be at most one unlock-notify callback registered by a +** blocked connection. If tdsqlite3_unlock_notify() is called when the +** blocked connection already has a registered unlock-notify callback, +** then the new callback replaces the old.)^ ^If tdsqlite3_unlock_notify() is +** called with a NULL pointer as its second argument, then any existing +** unlock-notify callback is canceled. ^The blocked connections +** unlock-notify callback may also be canceled by closing the blocked +** connection using [tdsqlite3_close()]. +** +** The unlock-notify callback is not reentrant. If an application invokes +** any tdsqlite3_xxx API functions from within an unlock-notify callback, a +** crash or deadlock may be the result. +** +** ^Unless deadlock is detected (see below), tdsqlite3_unlock_notify() always +** returns SQLITE_OK. +** +** Callback Invocation Details +** +** When an unlock-notify callback is registered, the application provides a +** single void* pointer that is passed to the callback when it is invoked. +** However, the signature of the callback function allows SQLite to pass +** it an array of void* context pointers. The first argument passed to +** an unlock-notify callback is a pointer to an array of void* pointers, +** and the second is the number of entries in the array. +** +** When a blocking connection's transaction is concluded, there may be +** more than one blocked connection that has registered for an unlock-notify +** callback. ^If two or more such blocked connections have specified the +** same callback function, then instead of invoking the callback function +** multiple times, it is invoked once with the set of void* context pointers +** specified by the blocked connections bundled together into an array. +** This gives the application an opportunity to prioritize any actions +** related to the set of unblocked database connections. +** +** Deadlock Detection +** +** Assuming that after registering for an unlock-notify callback a +** database waits for the callback to be issued before taking any further +** action (a reasonable assumption), then using this API may cause the +** application to deadlock. For example, if connection X is waiting for +** connection Y's transaction to be concluded, and similarly connection +** Y is waiting on connection X's transaction, then neither connection +** will proceed and the system may remain deadlocked indefinitely. +** +** To avoid this scenario, the tdsqlite3_unlock_notify() performs deadlock +** detection. ^If a given call to tdsqlite3_unlock_notify() would put the +** system in a deadlocked state, then SQLITE_LOCKED is returned and no +** unlock-notify callback is registered. The system is said to be in +** a deadlocked state if connection A has registered for an unlock-notify +** callback on the conclusion of connection B's transaction, and connection +** B has itself registered for an unlock-notify callback when connection +** A's transaction is concluded. ^Indirect deadlock is also detected, so +** the system is also considered to be deadlocked if connection B has +** registered for an unlock-notify callback on the conclusion of connection +** C's transaction, where connection C is waiting on connection A. ^Any +** number of levels of indirection are allowed. +** +** The "DROP TABLE" Exception +** +** When a call to [tdsqlite3_step()] returns SQLITE_LOCKED, it is almost +** always appropriate to call tdsqlite3_unlock_notify(). There is however, +** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement, +** SQLite checks if there are any currently executing SELECT statements +** that belong to the same connection. If there are, SQLITE_LOCKED is +** returned. In this case there is no "blocking connection", so invoking +** tdsqlite3_unlock_notify() results in the unlock-notify callback being +** invoked immediately. If the application then re-attempts the "DROP TABLE" +** or "DROP INDEX" query, an infinite loop might be the result. +** +** One way around this problem is to check the extended error code returned +** by an tdsqlite3_step() call. ^(If there is a blocking connection, then the +** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in +** the special "DROP TABLE/INDEX" case, the extended error code is just +** SQLITE_LOCKED.)^ +*/ +SQLITE_API int tdsqlite3_unlock_notify( + tdsqlite3 *pBlocked, /* Waiting connection */ + void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */ + void *pNotifyArg /* Argument to pass to xNotify */ +); + + +/* +** CAPI3REF: String Comparison +** +** ^The [tdsqlite3_stricmp()] and [tdsqlite3_strnicmp()] APIs allow applications +** and extensions to compare the contents of two buffers containing UTF-8 +** strings in a case-independent fashion, using the same definition of "case +** independence" that SQLite uses internally when comparing identifiers. +*/ +SQLITE_API int tdsqlite3_stricmp(const char *, const char *); +SQLITE_API int tdsqlite3_strnicmp(const char *, const char *, int); + +/* +** CAPI3REF: String Globbing +* +** ^The [tdsqlite3_strglob(P,X)] interface returns zero if and only if +** string X matches the [GLOB] pattern P. +** ^The definition of [GLOB] pattern matching used in +** [tdsqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the +** SQL dialect understood by SQLite. ^The [tdsqlite3_strglob(P,X)] function +** is case sensitive. +** +** Note that this routine returns zero on a match and non-zero if the strings +** do not match, the same as [tdsqlite3_stricmp()] and [tdsqlite3_strnicmp()]. +** +** See also: [tdsqlite3_strlike()]. +*/ +SQLITE_API int tdsqlite3_strglob(const char *zGlob, const char *zStr); + +/* +** CAPI3REF: String LIKE Matching +* +** ^The [tdsqlite3_strlike(P,X,E)] interface returns zero if and only if +** string X matches the [LIKE] pattern P with escape character E. +** ^The definition of [LIKE] pattern matching used in +** [tdsqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E" +** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without +** the ESCAPE clause, set the E parameter of [tdsqlite3_strlike(P,X,E)] to 0. +** ^As with the LIKE operator, the [tdsqlite3_strlike(P,X,E)] function is case +** insensitive - equivalent upper and lower case ASCII characters match +** one another. +** +** ^The [tdsqlite3_strlike(P,X,E)] function matches Unicode characters, though +** only ASCII characters are case folded. +** +** Note that this routine returns zero on a match and non-zero if the strings +** do not match, the same as [tdsqlite3_stricmp()] and [tdsqlite3_strnicmp()]. +** +** See also: [tdsqlite3_strglob()]. +*/ +SQLITE_API int tdsqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc); + +/* +** CAPI3REF: Error Logging Interface +** +** ^The [tdsqlite3_log()] interface writes a message into the [error log] +** established by the [SQLITE_CONFIG_LOG] option to [tdsqlite3_config()]. +** ^If logging is enabled, the zFormat string and subsequent arguments are +** used with [tdsqlite3_snprintf()] to generate the final output string. +** +** The tdsqlite3_log() interface is intended for use by extensions such as +** virtual tables, collating functions, and SQL functions. While there is +** nothing to prevent an application from calling tdsqlite3_log(), doing so +** is considered bad form. +** +** The zFormat string must not be NULL. +** +** To avoid deadlocks and other threading problems, the tdsqlite3_log() routine +** will not use dynamically allocated memory. The log message is stored in +** a fixed-length buffer on the stack. If the log message is longer than +** a few hundred characters, it will be truncated to the length of the +** buffer. +*/ +SQLITE_API void tdsqlite3_log(int iErrCode, const char *zFormat, ...); + +/* +** CAPI3REF: Write-Ahead Log Commit Hook +** METHOD: tdsqlite3 +** +** ^The [tdsqlite3_wal_hook()] function is used to register a callback that +** is invoked each time data is committed to a database in wal mode. +** +** ^(The callback is invoked by SQLite after the commit has taken place and +** the associated write-lock on the database released)^, so the implementation +** may read, write or [checkpoint] the database as required. +** +** ^The first parameter passed to the callback function when it is invoked +** is a copy of the third parameter passed to tdsqlite3_wal_hook() when +** registering the callback. ^The second is a copy of the database handle. +** ^The third parameter is the name of the database that was written to - +** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter +** is the number of pages currently in the write-ahead log file, +** including those that were just committed. +** +** The callback function should normally return [SQLITE_OK]. ^If an error +** code is returned, that error will propagate back up through the +** SQLite code base to cause the statement that provoked the callback +** to report an error, though the commit will have still occurred. If the +** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value +** that does not correspond to any valid SQLite error code, the results +** are undefined. +** +** A single database handle may have at most a single write-ahead log callback +** registered at one time. ^Calling [tdsqlite3_wal_hook()] replaces any +** previously registered write-ahead log callback. ^Note that the +** [tdsqlite3_wal_autocheckpoint()] interface and the +** [wal_autocheckpoint pragma] both invoke [tdsqlite3_wal_hook()] and will +** overwrite any prior [tdsqlite3_wal_hook()] settings. +*/ +SQLITE_API void *tdsqlite3_wal_hook( + tdsqlite3*, + int(*)(void *,tdsqlite3*,const char*,int), + void* +); + +/* +** CAPI3REF: Configure an auto-checkpoint +** METHOD: tdsqlite3 +** +** ^The [tdsqlite3_wal_autocheckpoint(D,N)] is a wrapper around +** [tdsqlite3_wal_hook()] that causes any database on [database connection] D +** to automatically [checkpoint] +** after committing a transaction if there are N or +** more frames in the [write-ahead log] file. ^Passing zero or +** a negative value as the nFrame parameter disables automatic +** checkpoints entirely. +** +** ^The callback registered by this function replaces any existing callback +** registered using [tdsqlite3_wal_hook()]. ^Likewise, registering a callback +** using [tdsqlite3_wal_hook()] disables the automatic checkpoint mechanism +** configured by this function. +** +** ^The [wal_autocheckpoint pragma] can be used to invoke this interface +** from SQL. +** +** ^Checkpoints initiated by this mechanism are +** [tdsqlite3_wal_checkpoint_v2|PASSIVE]. +** +** ^Every new [database connection] defaults to having the auto-checkpoint +** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT] +** pages. The use of this interface +** is only necessary if the default setting is found to be suboptimal +** for a particular application. +*/ +SQLITE_API int tdsqlite3_wal_autocheckpoint(tdsqlite3 *db, int N); + +/* +** CAPI3REF: Checkpoint a database +** METHOD: tdsqlite3 +** +** ^(The tdsqlite3_wal_checkpoint(D,X) is equivalent to +** [tdsqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^ +** +** In brief, tdsqlite3_wal_checkpoint(D,X) causes the content in the +** [write-ahead log] for database X on [database connection] D to be +** transferred into the database file and for the write-ahead log to +** be reset. See the [checkpointing] documentation for addition +** information. +** +** This interface used to be the only way to cause a checkpoint to +** occur. But then the newer and more powerful [tdsqlite3_wal_checkpoint_v2()] +** interface was added. This interface is retained for backwards +** compatibility and as a convenience for applications that need to manually +** start a callback but which do not need the full power (and corresponding +** complication) of [tdsqlite3_wal_checkpoint_v2()]. +*/ +SQLITE_API int tdsqlite3_wal_checkpoint(tdsqlite3 *db, const char *zDb); + +/* +** CAPI3REF: Checkpoint a database +** METHOD: tdsqlite3 +** +** ^(The tdsqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint +** operation on database X of [database connection] D in mode M. Status +** information is written back into integers pointed to by L and C.)^ +** ^(The M parameter must be a valid [checkpoint mode]:)^ +** +**
+**
SQLITE_CHECKPOINT_PASSIVE
+** ^Checkpoint as many frames as possible without waiting for any database +** readers or writers to finish, then sync the database file if all frames +** in the log were checkpointed. ^The [busy-handler callback] +** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode. +** ^On the other hand, passive mode might leave the checkpoint unfinished +** if there are concurrent readers or writers. +** +**
SQLITE_CHECKPOINT_FULL
+** ^This mode blocks (it invokes the +** [tdsqlite3_busy_handler|busy-handler callback]) until there is no +** database writer and all readers are reading from the most recent database +** snapshot. ^It then checkpoints all frames in the log file and syncs the +** database file. ^This mode blocks new database writers while it is pending, +** but new database readers are allowed to continue unimpeded. +** +**
SQLITE_CHECKPOINT_RESTART
+** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition +** that after checkpointing the log file it blocks (calls the +** [busy-handler callback]) +** until all readers are reading from the database file only. ^This ensures +** that the next writer will restart the log file from the beginning. +** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new +** database writer attempts while it is pending, but does not impede readers. +** +**
SQLITE_CHECKPOINT_TRUNCATE
+** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the +** addition that it also truncates the log file to zero bytes just prior +** to a successful return. +**
+** +** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in +** the log file or to -1 if the checkpoint could not run because +** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not +** NULL,then *pnCkpt is set to the total number of checkpointed frames in the +** log file (including any that were already checkpointed before the function +** was called) or to -1 if the checkpoint could not run due to an error or +** because the database is not in WAL mode. ^Note that upon successful +** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been +** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero. +** +** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If +** any other process is running a checkpoint operation at the same time, the +** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a +** busy-handler configured, it will not be invoked in this case. +** +** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the +** exclusive "writer" lock on the database file. ^If the writer lock cannot be +** obtained immediately, and a busy-handler is configured, it is invoked and +** the writer lock retried until either the busy-handler returns 0 or the lock +** is successfully obtained. ^The busy-handler is also invoked while waiting for +** database readers as described above. ^If the busy-handler returns 0 before +** the writer lock is obtained or while waiting for database readers, the +** checkpoint operation proceeds from that point in the same way as +** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible +** without blocking any further. ^SQLITE_BUSY is returned in this case. +** +** ^If parameter zDb is NULL or points to a zero length string, then the +** specified operation is attempted on all WAL databases [attached] to +** [database connection] db. In this case the +** values written to output parameters *pnLog and *pnCkpt are undefined. ^If +** an SQLITE_BUSY error is encountered when processing one or more of the +** attached WAL databases, the operation is still attempted on any remaining +** attached databases and SQLITE_BUSY is returned at the end. ^If any other +** error occurs while processing an attached database, processing is abandoned +** and the error code is returned to the caller immediately. ^If no error +** (SQLITE_BUSY or otherwise) is encountered while processing the attached +** databases, SQLITE_OK is returned. +** +** ^If database zDb is the name of an attached database that is not in WAL +** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If +** zDb is not NULL (or a zero length string) and is not the name of any +** attached database, SQLITE_ERROR is returned to the caller. +** +** ^Unless it returns SQLITE_MISUSE, +** the tdsqlite3_wal_checkpoint_v2() interface +** sets the error information that is queried by +** [tdsqlite3_errcode()] and [tdsqlite3_errmsg()]. +** +** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface +** from SQL. +*/ +SQLITE_API int tdsqlite3_wal_checkpoint_v2( + tdsqlite3 *db, /* Database handle */ + const char *zDb, /* Name of attached database (or NULL) */ + int eMode, /* SQLITE_CHECKPOINT_* value */ + int *pnLog, /* OUT: Size of WAL log in frames */ + int *pnCkpt /* OUT: Total number of frames checkpointed */ +); + +/* +** CAPI3REF: Checkpoint Mode Values +** KEYWORDS: {checkpoint mode} +** +** These constants define all valid values for the "checkpoint mode" passed +** as the third parameter to the [tdsqlite3_wal_checkpoint_v2()] interface. +** See the [tdsqlite3_wal_checkpoint_v2()] documentation for details on the +** meaning of each of these checkpoint modes. +*/ +#define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */ +#define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */ +#define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for for readers */ +#define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */ + +/* +** CAPI3REF: Virtual Table Interface Configuration +** +** This function may be called by either the [xConnect] or [xCreate] method +** of a [virtual table] implementation to configure +** various facets of the virtual table interface. +** +** If this interface is invoked outside the context of an xConnect or +** xCreate virtual table method then the behavior is undefined. +** +** In the call tdsqlite3_vtab_config(D,C,...) the D parameter is the +** [database connection] in which the virtual table is being created and +** which is passed in as the first argument to the [xConnect] or [xCreate] +** method that is invoking tdsqlite3_vtab_config(). The C parameter is one +** of the [virtual table configuration options]. The presence and meaning +** of parameters after C depend on which [virtual table configuration option] +** is used. +*/ +SQLITE_API int tdsqlite3_vtab_config(tdsqlite3*, int op, ...); + +/* +** CAPI3REF: Virtual Table Configuration Options +** KEYWORDS: {virtual table configuration options} +** KEYWORDS: {virtual table configuration option} +** +** These macros define the various options to the +** [tdsqlite3_vtab_config()] interface that [virtual table] implementations +** can use to customize and optimize their behavior. +** +**
+** [[SQLITE_VTAB_CONSTRAINT_SUPPORT]] +**
SQLITE_VTAB_CONSTRAINT_SUPPORT
+**
Calls of the form +** [tdsqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported, +** where X is an integer. If X is zero, then the [virtual table] whose +** [xCreate] or [xConnect] method invoked [tdsqlite3_vtab_config()] does not +** support constraints. In this configuration (which is the default) if +** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire +** statement is rolled back as if [ON CONFLICT | OR ABORT] had been +** specified as part of the users SQL statement, regardless of the actual +** ON CONFLICT mode specified. +** +** If X is non-zero, then the virtual table implementation guarantees +** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before +** any modifications to internal or persistent data structures have been made. +** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite +** is able to roll back a statement or database transaction, and abandon +** or continue processing the current SQL statement as appropriate. +** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns +** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode +** had been ABORT. +** +** Virtual table implementations that are required to handle OR REPLACE +** must do so within the [xUpdate] method. If a call to the +** [tdsqlite3_vtab_on_conflict()] function indicates that the current ON +** CONFLICT policy is REPLACE, the virtual table implementation should +** silently replace the appropriate rows within the xUpdate callback and +** return SQLITE_OK. Or, if this is not possible, it may return +** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT +** constraint handling. +**
+** +** [[SQLITE_VTAB_DIRECTONLY]]
SQLITE_VTAB_DIRECTONLY
+**
Calls of the form +** [tdsqlite3_vtab_config](db,SQLITE_VTAB_DIRECTONLY) from within the +** the [xConnect] or [xCreate] methods of a [virtual table] implmentation +** prohibits that virtual table from being used from within triggers and +** views. +**
+** +** [[SQLITE_VTAB_INNOCUOUS]]
SQLITE_VTAB_INNOCUOUS
+**
Calls of the form +** [tdsqlite3_vtab_config](db,SQLITE_VTAB_INNOCUOUS) from within the +** the [xConnect] or [xCreate] methods of a [virtual table] implmentation +** identify that virtual table as being safe to use from within triggers +** and views. Conceptually, the SQLITE_VTAB_INNOCUOUS tag means that the +** virtual table can do no serious harm even if it is controlled by a +** malicious hacker. Developers should avoid setting the SQLITE_VTAB_INNOCUOUS +** flag unless absolutely necessary. +**
+**
+*/ +#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1 +#define SQLITE_VTAB_INNOCUOUS 2 +#define SQLITE_VTAB_DIRECTONLY 3 + +/* +** CAPI3REF: Determine The Virtual Table Conflict Policy +** +** This function may only be called from within a call to the [xUpdate] method +** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The +** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL], +** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode +** of the SQL statement that triggered the call to the [xUpdate] method of the +** [virtual table]. +*/ +SQLITE_API int tdsqlite3_vtab_on_conflict(tdsqlite3 *); + +/* +** CAPI3REF: Determine If Virtual Table Column Access Is For UPDATE +** +** If the tdsqlite3_vtab_nochange(X) routine is called within the [xColumn] +** method of a [virtual table], then it returns true if and only if the +** column is being fetched as part of an UPDATE operation during which the +** column value will not change. Applications might use this to substitute +** a return value that is less expensive to compute and that the corresponding +** [xUpdate] method understands as a "no-change" value. +** +** If the [xColumn] method calls tdsqlite3_vtab_nochange() and finds that +** the column is not changed by the UPDATE statement, then the xColumn +** method can optionally return without setting a result, without calling +** any of the [tdsqlite3_result_int|tdsqlite3_result_xxxxx() interfaces]. +** In that case, [tdsqlite3_value_nochange(X)] will return true for the +** same column in the [xUpdate] method. +*/ +SQLITE_API int tdsqlite3_vtab_nochange(tdsqlite3_context*); + +/* +** CAPI3REF: Determine The Collation For a Virtual Table Constraint +** +** This function may only be called from within a call to the [xBestIndex] +** method of a [virtual table]. +** +** The first argument must be the tdsqlite3_index_info object that is the +** first parameter to the xBestIndex() method. The second argument must be +** an index into the aConstraint[] array belonging to the tdsqlite3_index_info +** structure passed to xBestIndex. This function returns a pointer to a buffer +** containing the name of the collation sequence for the corresponding +** constraint. +*/ +SQLITE_API SQLITE_EXPERIMENTAL const char *tdsqlite3_vtab_collation(tdsqlite3_index_info*,int); + +/* +** CAPI3REF: Conflict resolution modes +** KEYWORDS: {conflict resolution mode} +** +** These constants are returned by [tdsqlite3_vtab_on_conflict()] to +** inform a [virtual table] implementation what the [ON CONFLICT] mode +** is for the SQL statement being evaluated. +** +** Note that the [SQLITE_IGNORE] constant is also used as a potential +** return value from the [tdsqlite3_set_authorizer()] callback and that +** [SQLITE_ABORT] is also a [result code]. +*/ +#define SQLITE_ROLLBACK 1 +/* #define SQLITE_IGNORE 2 // Also used by tdsqlite3_authorizer() callback */ +#define SQLITE_FAIL 3 +/* #define SQLITE_ABORT 4 // Also an error code */ +#define SQLITE_REPLACE 5 + +/* +** CAPI3REF: Prepared Statement Scan Status Opcodes +** KEYWORDS: {scanstatus options} +** +** The following constants can be used for the T parameter to the +** [tdsqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a +** different metric for tdsqlite3_stmt_scanstatus() to return. +** +** When the value returned to V is a string, space to hold that string is +** managed by the prepared statement S and will be automatically freed when +** S is finalized. +** +**
+** [[SQLITE_SCANSTAT_NLOOP]]
SQLITE_SCANSTAT_NLOOP
+**
^The [tdsqlite3_int64] variable pointed to by the V parameter will be +** set to the total number of times that the X-th loop has run.
+** +** [[SQLITE_SCANSTAT_NVISIT]]
SQLITE_SCANSTAT_NVISIT
+**
^The [tdsqlite3_int64] variable pointed to by the V parameter will be set +** to the total number of rows examined by all iterations of the X-th loop.
+** +** [[SQLITE_SCANSTAT_EST]]
SQLITE_SCANSTAT_EST
+**
^The "double" variable pointed to by the V parameter will be set to the +** query planner's estimate for the average number of rows output from each +** iteration of the X-th loop. If the query planner's estimates was accurate, +** then this value will approximate the quotient NVISIT/NLOOP and the +** product of this value for all prior loops with the same SELECTID will +** be the NLOOP value for the current loop. +** +** [[SQLITE_SCANSTAT_NAME]]
SQLITE_SCANSTAT_NAME
+**
^The "const char *" variable pointed to by the V parameter will be set +** to a zero-terminated UTF-8 string containing the name of the index or table +** used for the X-th loop. +** +** [[SQLITE_SCANSTAT_EXPLAIN]]
SQLITE_SCANSTAT_EXPLAIN
+**
^The "const char *" variable pointed to by the V parameter will be set +** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN] +** description for the X-th loop. +** +** [[SQLITE_SCANSTAT_SELECTID]]
SQLITE_SCANSTAT_SELECT
+**
^The "int" variable pointed to by the V parameter will be set to the +** "select-id" for the X-th loop. The select-id identifies which query or +** subquery the loop is part of. The main query has a select-id of zero. +** The select-id is the same value as is output in the first column +** of an [EXPLAIN QUERY PLAN] query. +**
+*/ +#define SQLITE_SCANSTAT_NLOOP 0 +#define SQLITE_SCANSTAT_NVISIT 1 +#define SQLITE_SCANSTAT_EST 2 +#define SQLITE_SCANSTAT_NAME 3 +#define SQLITE_SCANSTAT_EXPLAIN 4 +#define SQLITE_SCANSTAT_SELECTID 5 + +/* +** CAPI3REF: Prepared Statement Scan Status +** METHOD: tdsqlite3_stmt +** +** This interface returns information about the predicted and measured +** performance for pStmt. Advanced applications can use this +** interface to compare the predicted and the measured performance and +** issue warnings and/or rerun [ANALYZE] if discrepancies are found. +** +** Since this interface is expected to be rarely used, it is only +** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS] +** compile-time option. +** +** The "iScanStatusOp" parameter determines which status information to return. +** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior +** of this interface is undefined. +** ^The requested measurement is written into a variable pointed to by +** the "pOut" parameter. +** Parameter "idx" identifies the specific loop to retrieve statistics for. +** Loops are numbered starting from zero. ^If idx is out of range - less than +** zero or greater than or equal to the total number of loops used to implement +** the statement - a non-zero value is returned and the variable that pOut +** points to is unchanged. +** +** ^Statistics might not be available for all loops in all statements. ^In cases +** where there exist loops with no available statistics, this function behaves +** as if the loop did not exist - it returns non-zero and leave the variable +** that pOut points to unchanged. +** +** See also: [tdsqlite3_stmt_scanstatus_reset()] +*/ +SQLITE_API int tdsqlite3_stmt_scanstatus( + tdsqlite3_stmt *pStmt, /* Prepared statement for which info desired */ + int idx, /* Index of loop to report on */ + int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */ + void *pOut /* Result written here */ +); + +/* +** CAPI3REF: Zero Scan-Status Counters +** METHOD: tdsqlite3_stmt +** +** ^Zero all [tdsqlite3_stmt_scanstatus()] related event counters. +** +** This API is only available if the library is built with pre-processor +** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined. +*/ +SQLITE_API void tdsqlite3_stmt_scanstatus_reset(tdsqlite3_stmt*); + +/* +** CAPI3REF: Flush caches to disk mid-transaction +** +** ^If a write-transaction is open on [database connection] D when the +** [tdsqlite3_db_cacheflush(D)] interface invoked, any dirty +** pages in the pager-cache that are not currently in use are written out +** to disk. A dirty page may be in use if a database cursor created by an +** active SQL statement is reading from it, or if it is page 1 of a database +** file (page 1 is always "in use"). ^The [tdsqlite3_db_cacheflush(D)] +** interface flushes caches for all schemas - "main", "temp", and +** any [attached] databases. +** +** ^If this function needs to obtain extra database locks before dirty pages +** can be flushed to disk, it does so. ^If those locks cannot be obtained +** immediately and there is a busy-handler callback configured, it is invoked +** in the usual manner. ^If the required lock still cannot be obtained, then +** the database is skipped and an attempt made to flush any dirty pages +** belonging to the next (if any) database. ^If any databases are skipped +** because locks cannot be obtained, but no other error occurs, this +** function returns SQLITE_BUSY. +** +** ^If any other error occurs while flushing dirty pages to disk (for +** example an IO error or out-of-memory condition), then processing is +** abandoned and an SQLite [error code] is returned to the caller immediately. +** +** ^Otherwise, if no error occurs, [tdsqlite3_db_cacheflush()] returns SQLITE_OK. +** +** ^This function does not set the database handle error code or message +** returned by the [tdsqlite3_errcode()] and [tdsqlite3_errmsg()] functions. +*/ +SQLITE_API int tdsqlite3_db_cacheflush(tdsqlite3*); + +/* +** CAPI3REF: The pre-update hook. +** +** ^These interfaces are only available if SQLite is compiled using the +** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option. +** +** ^The [tdsqlite3_preupdate_hook()] interface registers a callback function +** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation +** on a database table. +** ^At most one preupdate hook may be registered at a time on a single +** [database connection]; each call to [tdsqlite3_preupdate_hook()] overrides +** the previous setting. +** ^The preupdate hook is disabled by invoking [tdsqlite3_preupdate_hook()] +** with a NULL pointer as the second parameter. +** ^The third parameter to [tdsqlite3_preupdate_hook()] is passed through as +** the first parameter to callbacks. +** +** ^The preupdate hook only fires for changes to real database tables; the +** preupdate hook is not invoked for changes to [virtual tables] or to +** system tables like sqlite_master or sqlite_stat1. +** +** ^The second parameter to the preupdate callback is a pointer to +** the [database connection] that registered the preupdate hook. +** ^The third parameter to the preupdate callback is one of the constants +** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the +** kind of update operation that is about to occur. +** ^(The fourth parameter to the preupdate callback is the name of the +** database within the database connection that is being modified. This +** will be "main" for the main database or "temp" for TEMP tables or +** the name given after the AS keyword in the [ATTACH] statement for attached +** databases.)^ +** ^The fifth parameter to the preupdate callback is the name of the +** table that is being modified. +** +** For an UPDATE or DELETE operation on a [rowid table], the sixth +** parameter passed to the preupdate callback is the initial [rowid] of the +** row being modified or deleted. For an INSERT operation on a rowid table, +** or any operation on a WITHOUT ROWID table, the value of the sixth +** parameter is undefined. For an INSERT or UPDATE on a rowid table the +** seventh parameter is the final rowid value of the row being inserted +** or updated. The value of the seventh parameter passed to the callback +** function is not defined for operations on WITHOUT ROWID tables, or for +** INSERT operations on rowid tables. +** +** The [tdsqlite3_preupdate_old()], [tdsqlite3_preupdate_new()], +** [tdsqlite3_preupdate_count()], and [tdsqlite3_preupdate_depth()] interfaces +** provide additional information about a preupdate event. These routines +** may only be called from within a preupdate callback. Invoking any of +** these routines from outside of a preupdate callback or with a +** [database connection] pointer that is different from the one supplied +** to the preupdate callback results in undefined and probably undesirable +** behavior. +** +** ^The [tdsqlite3_preupdate_count(D)] interface returns the number of columns +** in the row that is being inserted, updated, or deleted. +** +** ^The [tdsqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to +** a [protected tdsqlite3_value] that contains the value of the Nth column of +** the table row before it is updated. The N parameter must be between 0 +** and one less than the number of columns or the behavior will be +** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE +** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the +** behavior is undefined. The [tdsqlite3_value] that P points to +** will be destroyed when the preupdate callback returns. +** +** ^The [tdsqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to +** a [protected tdsqlite3_value] that contains the value of the Nth column of +** the table row after it is updated. The N parameter must be between 0 +** and one less than the number of columns or the behavior will be +** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE +** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the +** behavior is undefined. The [tdsqlite3_value] that P points to +** will be destroyed when the preupdate callback returns. +** +** ^The [tdsqlite3_preupdate_depth(D)] interface returns 0 if the preupdate +** callback was invoked as a result of a direct insert, update, or delete +** operation; or 1 for inserts, updates, or deletes invoked by top-level +** triggers; or 2 for changes resulting from triggers called by top-level +** triggers; and so forth. +** +** See also: [tdsqlite3_update_hook()] +*/ +#if defined(SQLITE_ENABLE_PREUPDATE_HOOK) +SQLITE_API void *tdsqlite3_preupdate_hook( + tdsqlite3 *db, + void(*xPreUpdate)( + void *pCtx, /* Copy of third arg to preupdate_hook() */ + tdsqlite3 *db, /* Database handle */ + int op, /* SQLITE_UPDATE, DELETE or INSERT */ + char const *zDb, /* Database name */ + char const *zName, /* Table name */ + tdsqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */ + tdsqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */ + ), + void* +); +SQLITE_API int tdsqlite3_preupdate_old(tdsqlite3 *, int, tdsqlite3_value **); +SQLITE_API int tdsqlite3_preupdate_count(tdsqlite3 *); +SQLITE_API int tdsqlite3_preupdate_depth(tdsqlite3 *); +SQLITE_API int tdsqlite3_preupdate_new(tdsqlite3 *, int, tdsqlite3_value **); +#endif + +/* +** CAPI3REF: Low-level system error code +** +** ^Attempt to return the underlying operating system error code or error +** number that caused the most recent I/O error or failure to open a file. +** The return value is OS-dependent. For example, on unix systems, after +** [tdsqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be +** called to get back the underlying "errno" that caused the problem, such +** as ENOSPC, EAUTH, EISDIR, and so forth. +*/ +SQLITE_API int tdsqlite3_system_errno(tdsqlite3*); + +/* +** CAPI3REF: Database Snapshot +** KEYWORDS: {snapshot} {tdsqlite3_snapshot} +** +** An instance of the snapshot object records the state of a [WAL mode] +** database for some specific point in history. +** +** In [WAL mode], multiple [database connections] that are open on the +** same database file can each be reading a different historical version +** of the database file. When a [database connection] begins a read +** transaction, that connection sees an unchanging copy of the database +** as it existed for the point in time when the transaction first started. +** Subsequent changes to the database from other connections are not seen +** by the reader until a new read transaction is started. +** +** The tdsqlite3_snapshot object records state information about an historical +** version of the database file so that it is possible to later open a new read +** transaction that sees that historical version of the database rather than +** the most recent version. +*/ +typedef struct tdsqlite3_snapshot { + unsigned char hidden[48]; +} tdsqlite3_snapshot; + +/* +** CAPI3REF: Record A Database Snapshot +** CONSTRUCTOR: tdsqlite3_snapshot +** +** ^The [tdsqlite3_snapshot_get(D,S,P)] interface attempts to make a +** new [tdsqlite3_snapshot] object that records the current state of +** schema S in database connection D. ^On success, the +** [tdsqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly +** created [tdsqlite3_snapshot] object into *P and returns SQLITE_OK. +** If there is not already a read-transaction open on schema S when +** this function is called, one is opened automatically. +** +** The following must be true for this function to succeed. If any of +** the following statements are false when tdsqlite3_snapshot_get() is +** called, SQLITE_ERROR is returned. The final value of *P is undefined +** in this case. +** +**
    +**
  • The database handle must not be in [autocommit mode]. +** +**
  • Schema S of [database connection] D must be a [WAL mode] database. +** +**
  • There must not be a write transaction open on schema S of database +** connection D. +** +**
  • One or more transactions must have been written to the current wal +** file since it was created on disk (by any connection). This means +** that a snapshot cannot be taken on a wal mode database with no wal +** file immediately after it is first opened. At least one transaction +** must be written to it first. +**
+** +** This function may also return SQLITE_NOMEM. If it is called with the +** database handle in autocommit mode but fails for some other reason, +** whether or not a read transaction is opened on schema S is undefined. +** +** The [tdsqlite3_snapshot] object returned from a successful call to +** [tdsqlite3_snapshot_get()] must be freed using [tdsqlite3_snapshot_free()] +** to avoid a memory leak. +** +** The [tdsqlite3_snapshot_get()] interface is only available when the +** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. +*/ +SQLITE_API SQLITE_EXPERIMENTAL int tdsqlite3_snapshot_get( + tdsqlite3 *db, + const char *zSchema, + tdsqlite3_snapshot **ppSnapshot +); + +/* +** CAPI3REF: Start a read transaction on an historical snapshot +** METHOD: tdsqlite3_snapshot +** +** ^The [tdsqlite3_snapshot_open(D,S,P)] interface either starts a new read +** transaction or upgrades an existing one for schema S of +** [database connection] D such that the read transaction refers to +** historical [snapshot] P, rather than the most recent change to the +** database. ^The [tdsqlite3_snapshot_open()] interface returns SQLITE_OK +** on success or an appropriate [error code] if it fails. +** +** ^In order to succeed, the database connection must not be in +** [autocommit mode] when [tdsqlite3_snapshot_open(D,S,P)] is called. If there +** is already a read transaction open on schema S, then the database handle +** must have no active statements (SELECT statements that have been passed +** to tdsqlite3_step() but not tdsqlite3_reset() or tdsqlite3_finalize()). +** SQLITE_ERROR is returned if either of these conditions is violated, or +** if schema S does not exist, or if the snapshot object is invalid. +** +** ^A call to tdsqlite3_snapshot_open() will fail to open if the specified +** snapshot has been overwritten by a [checkpoint]. In this case +** SQLITE_ERROR_SNAPSHOT is returned. +** +** If there is already a read transaction open when this function is +** invoked, then the same read transaction remains open (on the same +** database snapshot) if SQLITE_ERROR, SQLITE_BUSY or SQLITE_ERROR_SNAPSHOT +** is returned. If another error code - for example SQLITE_PROTOCOL or an +** SQLITE_IOERR error code - is returned, then the final state of the +** read transaction is undefined. If SQLITE_OK is returned, then the +** read transaction is now open on database snapshot P. +** +** ^(A call to [tdsqlite3_snapshot_open(D,S,P)] will fail if the +** database connection D does not know that the database file for +** schema S is in [WAL mode]. A database connection might not know +** that the database file is in [WAL mode] if there has been no prior +** I/O on that database connection, or if the database entered [WAL mode] +** after the most recent I/O on the database connection.)^ +** (Hint: Run "[PRAGMA application_id]" against a newly opened +** database connection in order to make it ready to use snapshots.) +** +** The [tdsqlite3_snapshot_open()] interface is only available when the +** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. +*/ +SQLITE_API SQLITE_EXPERIMENTAL int tdsqlite3_snapshot_open( + tdsqlite3 *db, + const char *zSchema, + tdsqlite3_snapshot *pSnapshot +); + +/* +** CAPI3REF: Destroy a snapshot +** DESTRUCTOR: tdsqlite3_snapshot +** +** ^The [tdsqlite3_snapshot_free(P)] interface destroys [tdsqlite3_snapshot] P. +** The application must eventually free every [tdsqlite3_snapshot] object +** using this routine to avoid a memory leak. +** +** The [tdsqlite3_snapshot_free()] interface is only available when the +** [SQLITE_ENABLE_SNAPSHOT] compile-time option is used. +*/ +SQLITE_API SQLITE_EXPERIMENTAL void tdsqlite3_snapshot_free(tdsqlite3_snapshot*); + +/* +** CAPI3REF: Compare the ages of two snapshot handles. +** METHOD: tdsqlite3_snapshot +** +** The tdsqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages +** of two valid snapshot handles. +** +** If the two snapshot handles are not associated with the same database +** file, the result of the comparison is undefined. +** +** Additionally, the result of the comparison is only valid if both of the +** snapshot handles were obtained by calling tdsqlite3_snapshot_get() since the +** last time the wal file was deleted. The wal file is deleted when the +** database is changed back to rollback mode or when the number of database +** clients drops to zero. If either snapshot handle was obtained before the +** wal file was last deleted, the value returned by this function +** is undefined. +** +** Otherwise, this API returns a negative value if P1 refers to an older +** snapshot than P2, zero if the two handles refer to the same database +** snapshot, and a positive value if P1 is a newer snapshot than P2. +** +** This interface is only available if SQLite is compiled with the +** [SQLITE_ENABLE_SNAPSHOT] option. +*/ +SQLITE_API SQLITE_EXPERIMENTAL int tdsqlite3_snapshot_cmp( + tdsqlite3_snapshot *p1, + tdsqlite3_snapshot *p2 +); + +/* +** CAPI3REF: Recover snapshots from a wal file +** METHOD: tdsqlite3_snapshot +** +** If a [WAL file] remains on disk after all database connections close +** (either through the use of the [SQLITE_FCNTL_PERSIST_WAL] [file control] +** or because the last process to have the database opened exited without +** calling [tdsqlite3_close()]) and a new connection is subsequently opened +** on that database and [WAL file], the [tdsqlite3_snapshot_open()] interface +** will only be able to open the last transaction added to the WAL file +** even though the WAL file contains other valid transactions. +** +** This function attempts to scan the WAL file associated with database zDb +** of database handle db and make all valid snapshots available to +** tdsqlite3_snapshot_open(). It is an error if there is already a read +** transaction open on the database, or if the database is not a WAL mode +** database. +** +** SQLITE_OK is returned if successful, or an SQLite error code otherwise. +** +** This interface is only available if SQLite is compiled with the +** [SQLITE_ENABLE_SNAPSHOT] option. +*/ +SQLITE_API SQLITE_EXPERIMENTAL int tdsqlite3_snapshot_recover(tdsqlite3 *db, const char *zDb); + +/* +** CAPI3REF: Serialize a database +** +** The tdsqlite3_serialize(D,S,P,F) interface returns a pointer to memory +** that is a serialization of the S database on [database connection] D. +** If P is not a NULL pointer, then the size of the database in bytes +** is written into *P. +** +** For an ordinary on-disk database file, the serialization is just a +** copy of the disk file. For an in-memory database or a "TEMP" database, +** the serialization is the same sequence of bytes which would be written +** to disk if that database where backed up to disk. +** +** The usual case is that tdsqlite3_serialize() copies the serialization of +** the database into memory obtained from [tdsqlite3_malloc64()] and returns +** a pointer to that memory. The caller is responsible for freeing the +** returned value to avoid a memory leak. However, if the F argument +** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations +** are made, and the tdsqlite3_serialize() function will return a pointer +** to the contiguous memory representation of the database that SQLite +** is currently using for that database, or NULL if the no such contiguous +** memory representation of the database exists. A contiguous memory +** representation of the database will usually only exist if there has +** been a prior call to [tdsqlite3_deserialize(D,S,...)] with the same +** values of D and S. +** The size of the database is written into *P even if the +** SQLITE_SERIALIZE_NOCOPY bit is set but no contiguous copy +** of the database exists. +** +** A call to tdsqlite3_serialize(D,S,P,F) might return NULL even if the +** SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory +** allocation error occurs. +** +** This interface is only available if SQLite is compiled with the +** [SQLITE_ENABLE_DESERIALIZE] option. +*/ +SQLITE_API unsigned char *tdsqlite3_serialize( + tdsqlite3 *db, /* The database connection */ + const char *zSchema, /* Which DB to serialize. ex: "main", "temp", ... */ + tdsqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */ + unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */ +); + +/* +** CAPI3REF: Flags for tdsqlite3_serialize +** +** Zero or more of the following constants can be OR-ed together for +** the F argument to [tdsqlite3_serialize(D,S,P,F)]. +** +** SQLITE_SERIALIZE_NOCOPY means that [tdsqlite3_serialize()] will return +** a pointer to contiguous in-memory database that it is currently using, +** without making a copy of the database. If SQLite is not currently using +** a contiguous in-memory database, then this option causes +** [tdsqlite3_serialize()] to return a NULL pointer. SQLite will only be +** using a contiguous in-memory database if it has been initialized by a +** prior call to [tdsqlite3_deserialize()]. +*/ +#define SQLITE_SERIALIZE_NOCOPY 0x001 /* Do no memory allocations */ + +/* +** CAPI3REF: Deserialize a database +** +** The tdsqlite3_deserialize(D,S,P,N,M,F) interface causes the +** [database connection] D to disconnect from database S and then +** reopen S as an in-memory database based on the serialization contained +** in P. The serialized database P is N bytes in size. M is the size of +** the buffer P, which might be larger than N. If M is larger than N, and +** the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is +** permitted to add content to the in-memory database as long as the total +** size does not exceed M bytes. +** +** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will +** invoke tdsqlite3_free() on the serialization buffer when the database +** connection closes. If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then +** SQLite will try to increase the buffer size using tdsqlite3_realloc64() +** if writes on the database cause it to grow larger than M bytes. +** +** The tdsqlite3_deserialize() interface will fail with SQLITE_BUSY if the +** database is currently in a read transaction or is involved in a backup +** operation. +** +** If tdsqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the +** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then +** [tdsqlite3_free()] is invoked on argument P prior to returning. +** +** This interface is only available if SQLite is compiled with the +** [SQLITE_ENABLE_DESERIALIZE] option. +*/ +SQLITE_API int tdsqlite3_deserialize( + tdsqlite3 *db, /* The database connection */ + const char *zSchema, /* Which DB to reopen with the deserialization */ + unsigned char *pData, /* The serialized database content */ + tdsqlite3_int64 szDb, /* Number bytes in the deserialization */ + tdsqlite3_int64 szBuf, /* Total size of buffer pData[] */ + unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */ +); + +/* +** CAPI3REF: Flags for tdsqlite3_deserialize() +** +** The following are allowed values for 6th argument (the F argument) to +** the [tdsqlite3_deserialize(D,S,P,N,M,F)] interface. +** +** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization +** in the P argument is held in memory obtained from [tdsqlite3_malloc64()] +** and that SQLite should take ownership of this memory and automatically +** free it when it has finished using it. Without this flag, the caller +** is responsible for freeing any dynamically allocated memory. +** +** The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed to +** grow the size of the database using calls to [tdsqlite3_realloc64()]. This +** flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is also used. +** Without this flag, the deserialized database cannot increase in size beyond +** the number of bytes specified by the M parameter. +** +** The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database +** should be treated as read-only. +*/ +#define SQLITE_DESERIALIZE_FREEONCLOSE 1 /* Call tdsqlite3_free() on close */ +#define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using tdsqlite3_realloc64() */ +#define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */ + +/* +** Undo the hack that converts floating point types to integer for +** builds on processors without floating point support. +*/ +#ifdef SQLITE_OMIT_FLOATING_POINT +# undef double +#endif + +#ifdef __cplusplus +} /* End of the 'extern "C"' block */ +#endif +#endif /* SQLITE3_H */ + +/******** Begin file tdsqlite3rtree.h *********/ +/* +** 2010 August 30 +** +** The author disclaims copyright to this source code. In place of +** a legal notice, here is a blessing: +** +** May you do good and not evil. +** May you find forgiveness for yourself and forgive others. +** May you share freely, never taking more than you give. +** +************************************************************************* +*/ + +#ifndef _SQLITE3RTREE_H_ +#define _SQLITE3RTREE_H_ + + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct tdsqlite3_rtree_geometry tdsqlite3_rtree_geometry; +typedef struct tdsqlite3_rtree_query_info tdsqlite3_rtree_query_info; + +/* The double-precision datatype used by RTree depends on the +** SQLITE_RTREE_INT_ONLY compile-time option. +*/ +#ifdef SQLITE_RTREE_INT_ONLY + typedef tdsqlite3_int64 tdsqlite3_rtree_dbl; +#else + typedef double tdsqlite3_rtree_dbl; +#endif + +/* +** Register a geometry callback named zGeom that can be used as part of an +** R-Tree geometry query as follows: +** +** SELECT ... FROM WHERE MATCH $zGeom(... params ...) +*/ +SQLITE_API int tdsqlite3_rtree_geometry_callback( + tdsqlite3 *db, + const char *zGeom, + int (*xGeom)(tdsqlite3_rtree_geometry*, int, tdsqlite3_rtree_dbl*,int*), + void *pContext +); + + +/* +** A pointer to a structure of the following type is passed as the first +** argument to callbacks registered using rtree_geometry_callback(). +*/ +struct tdsqlite3_rtree_geometry { + void *pContext; /* Copy of pContext passed to s_r_g_c() */ + int nParam; /* Size of array aParam[] */ + tdsqlite3_rtree_dbl *aParam; /* Parameters passed to SQL geom function */ + void *pUser; /* Callback implementation user data */ + void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */ +}; + +/* +** Register a 2nd-generation geometry callback named zScore that can be +** used as part of an R-Tree geometry query as follows: +** +** SELECT ... FROM WHERE MATCH $zQueryFunc(... params ...) +*/ +SQLITE_API int tdsqlite3_rtree_query_callback( + tdsqlite3 *db, + const char *zQueryFunc, + int (*xQueryFunc)(tdsqlite3_rtree_query_info*), + void *pContext, + void (*xDestructor)(void*) +); + + +/* +** A pointer to a structure of the following type is passed as the +** argument to scored geometry callback registered using +** tdsqlite3_rtree_query_callback(). +** +** Note that the first 5 fields of this structure are identical to +** tdsqlite3_rtree_geometry. This structure is a subclass of +** tdsqlite3_rtree_geometry. +*/ +struct tdsqlite3_rtree_query_info { + void *pContext; /* pContext from when function registered */ + int nParam; /* Number of function parameters */ + tdsqlite3_rtree_dbl *aParam; /* value of function parameters */ + void *pUser; /* callback can use this, if desired */ + void (*xDelUser)(void*); /* function to free pUser */ + tdsqlite3_rtree_dbl *aCoord; /* Coordinates of node or entry to check */ + unsigned int *anQueue; /* Number of pending entries in the queue */ + int nCoord; /* Number of coordinates */ + int iLevel; /* Level of current node or entry */ + int mxLevel; /* The largest iLevel value in the tree */ + tdsqlite3_int64 iRowid; /* Rowid for current entry */ + tdsqlite3_rtree_dbl rParentScore; /* Score of parent node */ + int eParentWithin; /* Visibility of parent node */ + int eWithin; /* OUT: Visibility */ + tdsqlite3_rtree_dbl rScore; /* OUT: Write the score here */ + /* The following fields are only available in 3.8.11 and later */ + tdsqlite3_value **apSqlParam; /* Original SQL values of parameters */ +}; + +/* +** Allowed values for tdsqlite3_rtree_query.eWithin and .eParentWithin. +*/ +#define NOT_WITHIN 0 /* Object completely outside of query region */ +#define PARTLY_WITHIN 1 /* Object partially overlaps query region */ +#define FULLY_WITHIN 2 /* Object fully contained within query region */ + + +#ifdef __cplusplus +} /* end of the 'extern "C"' block */ +#endif + +#endif /* ifndef _SQLITE3RTREE_H_ */ + +/******** End of tdsqlite3rtree.h *********/ +/******** Begin file tdsqlite3session.h *********/ + +#if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) +#define __SQLITESESSION_H_ 1 + +/* +** Make sure we can call this stuff from C++. +*/ +#ifdef __cplusplus +extern "C" { +#endif + + +/* +** CAPI3REF: Session Object Handle +** +** An instance of this object is a [session] that can be used to +** record changes to a database. +*/ +typedef struct tdsqlite3_session tdsqlite3_session; + +/* +** CAPI3REF: Changeset Iterator Handle +** +** An instance of this object acts as a cursor for iterating +** over the elements of a [changeset] or [patchset]. +*/ +typedef struct tdsqlite3_changeset_iter tdsqlite3_changeset_iter; + +/* +** CAPI3REF: Create A New Session Object +** CONSTRUCTOR: tdsqlite3_session +** +** Create a new session object attached to database handle db. If successful, +** a pointer to the new object is written to *ppSession and SQLITE_OK is +** returned. If an error occurs, *ppSession is set to NULL and an SQLite +** error code (e.g. SQLITE_NOMEM) is returned. +** +** It is possible to create multiple session objects attached to a single +** database handle. +** +** Session objects created using this function should be deleted using the +** [tdsqlite3session_delete()] function before the database handle that they +** are attached to is itself closed. If the database handle is closed before +** the session object is deleted, then the results of calling any session +** module function, including [tdsqlite3session_delete()] on the session object +** are undefined. +** +** Because the session module uses the [tdsqlite3_preupdate_hook()] API, it +** is not possible for an application to register a pre-update hook on a +** database handle that has one or more session objects attached. Nor is +** it possible to create a session object attached to a database handle for +** which a pre-update hook is already defined. The results of attempting +** either of these things are undefined. +** +** The session object will be used to create changesets for tables in +** database zDb, where zDb is either "main", or "temp", or the name of an +** attached database. It is not an error if database zDb is not attached +** to the database when the session object is created. +*/ +SQLITE_API int tdsqlite3session_create( + tdsqlite3 *db, /* Database handle */ + const char *zDb, /* Name of db (e.g. "main") */ + tdsqlite3_session **ppSession /* OUT: New session object */ +); + +/* +** CAPI3REF: Delete A Session Object +** DESTRUCTOR: tdsqlite3_session +** +** Delete a session object previously allocated using +** [tdsqlite3session_create()]. Once a session object has been deleted, the +** results of attempting to use pSession with any other session module +** function are undefined. +** +** Session objects must be deleted before the database handle to which they +** are attached is closed. Refer to the documentation for +** [tdsqlite3session_create()] for details. +*/ +SQLITE_API void tdsqlite3session_delete(tdsqlite3_session *pSession); + + +/* +** CAPI3REF: Enable Or Disable A Session Object +** METHOD: tdsqlite3_session +** +** Enable or disable the recording of changes by a session object. When +** enabled, a session object records changes made to the database. When +** disabled - it does not. A newly created session object is enabled. +** Refer to the documentation for [tdsqlite3session_changeset()] for further +** details regarding how enabling and disabling a session object affects +** the eventual changesets. +** +** Passing zero to this function disables the session. Passing a value +** greater than zero enables it. Passing a value less than zero is a +** no-op, and may be used to query the current state of the session. +** +** The return value indicates the final state of the session object: 0 if +** the session is disabled, or 1 if it is enabled. +*/ +SQLITE_API int tdsqlite3session_enable(tdsqlite3_session *pSession, int bEnable); + +/* +** CAPI3REF: Set Or Clear the Indirect Change Flag +** METHOD: tdsqlite3_session +** +** Each change recorded by a session object is marked as either direct or +** indirect. A change is marked as indirect if either: +** +**
    +**
  • The session object "indirect" flag is set when the change is +** made, or +**
  • The change is made by an SQL trigger or foreign key action +** instead of directly as a result of a users SQL statement. +**
+** +** If a single row is affected by more than one operation within a session, +** then the change is considered indirect if all operations meet the criteria +** for an indirect change above, or direct otherwise. +** +** This function is used to set, clear or query the session object indirect +** flag. If the second argument passed to this function is zero, then the +** indirect flag is cleared. If it is greater than zero, the indirect flag +** is set. Passing a value less than zero does not modify the current value +** of the indirect flag, and may be used to query the current state of the +** indirect flag for the specified session object. +** +** The return value indicates the final state of the indirect flag: 0 if +** it is clear, or 1 if it is set. +*/ +SQLITE_API int tdsqlite3session_indirect(tdsqlite3_session *pSession, int bIndirect); + +/* +** CAPI3REF: Attach A Table To A Session Object +** METHOD: tdsqlite3_session +** +** If argument zTab is not NULL, then it is the name of a table to attach +** to the session object passed as the first argument. All subsequent changes +** made to the table while the session object is enabled will be recorded. See +** documentation for [tdsqlite3session_changeset()] for further details. +** +** Or, if argument zTab is NULL, then changes are recorded for all tables +** in the database. If additional tables are added to the database (by +** executing "CREATE TABLE" statements) after this call is made, changes for +** the new tables are also recorded. +** +** Changes can only be recorded for tables that have a PRIMARY KEY explicitly +** defined as part of their CREATE TABLE statement. It does not matter if the +** PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY +** KEY may consist of a single column, or may be a composite key. +** +** It is not an error if the named table does not exist in the database. Nor +** is it an error if the named table does not have a PRIMARY KEY. However, +** no changes will be recorded in either of these scenarios. +** +** Changes are not recorded for individual rows that have NULL values stored +** in one or more of their PRIMARY KEY columns. +** +** SQLITE_OK is returned if the call completes without error. Or, if an error +** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned. +** +**

Special sqlite_stat1 Handling

+** +** As of SQLite version 3.22.0, the "sqlite_stat1" table is an exception to +** some of the rules above. In SQLite, the schema of sqlite_stat1 is: +** 
+**        CREATE TABLE sqlite_stat1(tbl,idx,stat)  
+**
+** +** Even though sqlite_stat1 does not have a PRIMARY KEY, changes are +** recorded for it as if the PRIMARY KEY is (tbl,idx). Additionally, changes +** are recorded for rows for which (idx IS NULL) is true. However, for such +** rows a zero-length blob (SQL value X'') is stored in the changeset or +** patchset instead of a NULL value. This allows such changesets to be +** manipulated by legacy implementations of tdsqlite3changeset_invert(), +** concat() and similar. +** +** The tdsqlite3changeset_apply() function automatically converts the +** zero-length blob back to a NULL value when updating the sqlite_stat1 +** table. However, if the application calls tdsqlite3changeset_new(), +** tdsqlite3changeset_old() or tdsqlite3changeset_conflict on a changeset +** iterator directly (including on a changeset iterator passed to a +** conflict-handler callback) then the X'' value is returned. The application +** must translate X'' to NULL itself if required. +** +** Legacy (older than 3.22.0) versions of the sessions module cannot capture +** changes made to the sqlite_stat1 table. Legacy versions of the +** tdsqlite3changeset_apply() function silently ignore any modifications to the +** sqlite_stat1 table that are part of a changeset or patchset. +*/ +SQLITE_API int tdsqlite3session_attach( + tdsqlite3_session *pSession, /* Session object */ + const char *zTab /* Table name */ +); + +/* +** CAPI3REF: Set a table filter on a Session Object. +** METHOD: tdsqlite3_session +** +** The second argument (xFilter) is the "filter callback". For changes to rows +** in tables that are not attached to the Session object, the filter is called +** to determine whether changes to the table's rows should be tracked or not. +** If xFilter returns 0, changes are not tracked. Note that once a table is +** attached, xFilter will not be called again. +*/ +SQLITE_API void tdsqlite3session_table_filter( + tdsqlite3_session *pSession, /* Session object */ + int(*xFilter)( + void *pCtx, /* Copy of third arg to _filter_table() */ + const char *zTab /* Table name */ + ), + void *pCtx /* First argument passed to xFilter */ +); + +/* +** CAPI3REF: Generate A Changeset From A Session Object +** METHOD: tdsqlite3_session +** +** Obtain a changeset containing changes to the tables attached to the +** session object passed as the first argument. If successful, +** set *ppChangeset to point to a buffer containing the changeset +** and *pnChangeset to the size of the changeset in bytes before returning +** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to +** zero and return an SQLite error code. +** +** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes, +** each representing a change to a single row of an attached table. An INSERT +** change contains the values of each field of a new database row. A DELETE +** contains the original values of each field of a deleted database row. An +** UPDATE change contains the original values of each field of an updated +** database row along with the updated values for each updated non-primary-key +** column. It is not possible for an UPDATE change to represent a change that +** modifies the values of primary key columns. If such a change is made, it +** is represented in a changeset as a DELETE followed by an INSERT. +** +** Changes are not recorded for rows that have NULL values stored in one or +** more of their PRIMARY KEY columns. If such a row is inserted or deleted, +** no corresponding change is present in the changesets returned by this +** function. If an existing row with one or more NULL values stored in +** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL, +** only an INSERT is appears in the changeset. Similarly, if an existing row +** with non-NULL PRIMARY KEY values is updated so that one or more of its +** PRIMARY KEY columns are set to NULL, the resulting changeset contains a +** DELETE change only. +** +** The contents of a changeset may be traversed using an iterator created +** using the [tdsqlite3changeset_start()] API. A changeset may be applied to +** a database with a compatible schema using the [tdsqlite3changeset_apply()] +** API. +** +** Within a changeset generated by this function, all changes related to a +** single table are grouped together. In other words, when iterating through +** a changeset or when applying a changeset to a database, all changes related +** to a single table are processed before moving on to the next table. Tables +** are sorted in the same order in which they were attached (or auto-attached) +** to the tdsqlite3_session object. The order in which the changes related to +** a single table are stored is undefined. +** +** Following a successful call to this function, it is the responsibility of +** the caller to eventually free the buffer that *ppChangeset points to using +** [tdsqlite3_free()]. +** +**

Changeset Generation

+** +** Once a table has been attached to a session object, the session object +** records the primary key values of all new rows inserted into the table. +** It also records the original primary key and other column values of any +** deleted or updated rows. For each unique primary key value, data is only +** recorded once - the first time a row with said primary key is inserted, +** updated or deleted in the lifetime of the session. +** +** There is one exception to the previous paragraph: when a row is inserted, +** updated or deleted, if one or more of its primary key columns contain a +** NULL value, no record of the change is made. +** +** The session object therefore accumulates two types of records - those +** that consist of primary key values only (created when the user inserts +** a new record) and those that consist of the primary key values and the +** original values of other table columns (created when the users deletes +** or updates a record). +** +** When this function is called, the requested changeset is created using +** both the accumulated records and the current contents of the database +** file. Specifically: +** +**
    +**
  • For each record generated by an insert, the database is queried +** for a row with a matching primary key. If one is found, an INSERT +** change is added to the changeset. If no such row is found, no change +** is added to the changeset. +** +**
  • For each record generated by an update or delete, the database is +** queried for a row with a matching primary key. If such a row is +** found and one or more of the non-primary key fields have been +** modified from their original values, an UPDATE change is added to +** the changeset. Or, if no such row is found in the table, a DELETE +** change is added to the changeset. If there is a row with a matching +** primary key in the database, but all fields contain their original +** values, no change is added to the changeset. +**
+** +** This means, amongst other things, that if a row is inserted and then later +** deleted while a session object is active, neither the insert nor the delete +** will be present in the changeset. Or if a row is deleted and then later a +** row with the same primary key values inserted while a session object is +** active, the resulting changeset will contain an UPDATE change instead of +** a DELETE and an INSERT. +** +** When a session object is disabled (see the [tdsqlite3session_enable()] API), +** it does not accumulate records when rows are inserted, updated or deleted. +** This may appear to have some counter-intuitive effects if a single row +** is written to more than once during a session. For example, if a row +** is inserted while a session object is enabled, then later deleted while +** the same session object is disabled, no INSERT record will appear in the +** changeset, even though the delete took place while the session was disabled. +** Or, if one field of a row is updated while a session is disabled, and +** another field of the same row is updated while the session is enabled, the +** resulting changeset will contain an UPDATE change that updates both fields. +*/ +SQLITE_API int tdsqlite3session_changeset( + tdsqlite3_session *pSession, /* Session object */ + int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */ + void **ppChangeset /* OUT: Buffer containing changeset */ +); + +/* +** CAPI3REF: Load The Difference Between Tables Into A Session +** METHOD: tdsqlite3_session +** +** If it is not already attached to the session object passed as the first +** argument, this function attaches table zTbl in the same manner as the +** [tdsqlite3session_attach()] function. If zTbl does not exist, or if it +** does not have a primary key, this function is a no-op (but does not return +** an error). +** +** Argument zFromDb must be the name of a database ("main", "temp" etc.) +** attached to the same database handle as the session object that contains +** a table compatible with the table attached to the session by this function. +** A table is considered compatible if it: +** +**
    +**
  • Has the same name, +**
  • Has the same set of columns declared in the same order, and +**
  • Has the same PRIMARY KEY definition. +**
+** +** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables +** are compatible but do not have any PRIMARY KEY columns, it is not an error +** but no changes are added to the session object. As with other session +** APIs, tables without PRIMARY KEYs are simply ignored. +** +** This function adds a set of changes to the session object that could be +** used to update the table in database zFrom (call this the "from-table") +** so that its content is the same as the table attached to the session +** object (call this the "to-table"). Specifically: +** +**
    +**
  • For each row (primary key) that exists in the to-table but not in +** the from-table, an INSERT record is added to the session object. +** +**
  • For each row (primary key) that exists in the to-table but not in +** the from-table, a DELETE record is added to the session object. +** +**
  • For each row (primary key) that exists in both tables, but features +** different non-PK values in each, an UPDATE record is added to the +** session. +**
+** +** To clarify, if this function is called and then a changeset constructed +** using [tdsqlite3session_changeset()], then after applying that changeset to +** database zFrom the contents of the two compatible tables would be +** identical. +** +** It an error if database zFrom does not exist or does not contain the +** required compatible table. +** +** If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite +** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg +** may be set to point to a buffer containing an English language error +** message. It is the responsibility of the caller to free this buffer using +** tdsqlite3_free(). +*/ +SQLITE_API int tdsqlite3session_diff( + tdsqlite3_session *pSession, + const char *zFromDb, + const char *zTbl, + char **pzErrMsg +); + + +/* +** CAPI3REF: Generate A Patchset From A Session Object +** METHOD: tdsqlite3_session +** +** The differences between a patchset and a changeset are that: +** +**
    +**
  • DELETE records consist of the primary key fields only. The +** original values of other fields are omitted. +**
  • The original values of any modified fields are omitted from +** UPDATE records. +**
+** +** A patchset blob may be used with up to date versions of all +** tdsqlite3changeset_xxx API functions except for tdsqlite3changeset_invert(), +** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly, +** attempting to use a patchset blob with old versions of the +** tdsqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error. +** +** Because the non-primary key "old.*" fields are omitted, no +** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset +** is passed to the tdsqlite3changeset_apply() API. Other conflict types work +** in the same way as for changesets. +** +** Changes within a patchset are ordered in the same way as for changesets +** generated by the tdsqlite3session_changeset() function (i.e. all changes for +** a single table are grouped together, tables appear in the order in which +** they were attached to the session object). +*/ +SQLITE_API int tdsqlite3session_patchset( + tdsqlite3_session *pSession, /* Session object */ + int *pnPatchset, /* OUT: Size of buffer at *ppPatchset */ + void **ppPatchset /* OUT: Buffer containing patchset */ +); + +/* +** CAPI3REF: Test if a changeset has recorded any changes. +** +** Return non-zero if no changes to attached tables have been recorded by +** the session object passed as the first argument. Otherwise, if one or +** more changes have been recorded, return zero. +** +** Even if this function returns zero, it is possible that calling +** [tdsqlite3session_changeset()] on the session handle may still return a +** changeset that contains no changes. This can happen when a row in +** an attached table is modified and then later on the original values +** are restored. However, if this function returns non-zero, then it is +** guaranteed that a call to tdsqlite3session_changeset() will return a +** changeset containing zero changes. +*/ +SQLITE_API int tdsqlite3session_isempty(tdsqlite3_session *pSession); + +/* +** CAPI3REF: Create An Iterator To Traverse A Changeset +** CONSTRUCTOR: tdsqlite3_changeset_iter +** +** Create an iterator used to iterate through the contents of a changeset. +** If successful, *pp is set to point to the iterator handle and SQLITE_OK +** is returned. Otherwise, if an error occurs, *pp is set to zero and an +** SQLite error code is returned. +** +** The following functions can be used to advance and query a changeset +** iterator created by this function: +** +**
    +**
  • [tdsqlite3changeset_next()] +**
  • [tdsqlite3changeset_op()] +**
  • [tdsqlite3changeset_new()] +**
  • [tdsqlite3changeset_old()] +**
+** +** It is the responsibility of the caller to eventually destroy the iterator +** by passing it to [tdsqlite3changeset_finalize()]. The buffer containing the +** changeset (pChangeset) must remain valid until after the iterator is +** destroyed. +** +** Assuming the changeset blob was created by one of the +** [tdsqlite3session_changeset()], [tdsqlite3changeset_concat()] or +** [tdsqlite3changeset_invert()] functions, all changes within the changeset +** that apply to a single table are grouped together. This means that when +** an application iterates through a changeset using an iterator created by +** this function, all changes that relate to a single table are visited +** consecutively. There is no chance that the iterator will visit a change +** the applies to table X, then one for table Y, and then later on visit +** another change for table X. +** +** The behavior of tdsqlite3changeset_start_v2() and its streaming equivalent +** may be modified by passing a combination of +** [SQLITE_CHANGESETSTART_INVERT | supported flags] as the 4th parameter. +** +** Note that the tdsqlite3changeset_start_v2() API is still experimental +** and therefore subject to change. +*/ +SQLITE_API int tdsqlite3changeset_start( + tdsqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */ + int nChangeset, /* Size of changeset blob in bytes */ + void *pChangeset /* Pointer to blob containing changeset */ +); +SQLITE_API int tdsqlite3changeset_start_v2( + tdsqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */ + int nChangeset, /* Size of changeset blob in bytes */ + void *pChangeset, /* Pointer to blob containing changeset */ + int flags /* SESSION_CHANGESETSTART_* flags */ +); + +/* +** CAPI3REF: Flags for tdsqlite3changeset_start_v2 +** +** The following flags may passed via the 4th parameter to +** [tdsqlite3changeset_start_v2] and [tdsqlite3changeset_start_v2_strm]: +** +**
SQLITE_CHANGESETAPPLY_INVERT
+** Invert the changeset while iterating through it. This is equivalent to +** inverting a changeset using tdsqlite3changeset_invert() before applying it. +** It is an error to specify this flag with a patchset. +*/ +#define SQLITE_CHANGESETSTART_INVERT 0x0002 + + +/* +** CAPI3REF: Advance A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** This function may only be used with iterators created by the function +** [tdsqlite3changeset_start()]. If it is called on an iterator passed to +** a conflict-handler callback by [tdsqlite3changeset_apply()], SQLITE_MISUSE +** is returned and the call has no effect. +** +** Immediately after an iterator is created by tdsqlite3changeset_start(), it +** does not point to any change in the changeset. Assuming the changeset +** is not empty, the first call to this function advances the iterator to +** point to the first change in the changeset. Each subsequent call advances +** the iterator to point to the next change in the changeset (if any). If +** no error occurs and the iterator points to a valid change after a call +** to tdsqlite3changeset_next() has advanced it, SQLITE_ROW is returned. +** Otherwise, if all changes in the changeset have already been visited, +** SQLITE_DONE is returned. +** +** If an error occurs, an SQLite error code is returned. Possible error +** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or +** SQLITE_NOMEM. +*/ +SQLITE_API int tdsqlite3changeset_next(tdsqlite3_changeset_iter *pIter); + +/* +** CAPI3REF: Obtain The Current Operation From A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** The pIter argument passed to this function may either be an iterator +** passed to a conflict-handler by [tdsqlite3changeset_apply()], or an iterator +** created by [tdsqlite3changeset_start()]. In the latter case, the most recent +** call to [tdsqlite3changeset_next()] must have returned [SQLITE_ROW]. If this +** is not the case, this function returns [SQLITE_MISUSE]. +** +** If argument pzTab is not NULL, then *pzTab is set to point to a +** nul-terminated utf-8 encoded string containing the name of the table +** affected by the current change. The buffer remains valid until either +** tdsqlite3changeset_next() is called on the iterator or until the +** conflict-handler function returns. If pnCol is not NULL, then *pnCol is +** set to the number of columns in the table affected by the change. If +** pbIndirect is not NULL, then *pbIndirect is set to true (1) if the change +** is an indirect change, or false (0) otherwise. See the documentation for +** [tdsqlite3session_indirect()] for a description of direct and indirect +** changes. Finally, if pOp is not NULL, then *pOp is set to one of +** [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], depending on the +** type of change that the iterator currently points to. +** +** If no error occurs, SQLITE_OK is returned. If an error does occur, an +** SQLite error code is returned. The values of the output variables may not +** be trusted in this case. +*/ +SQLITE_API int tdsqlite3changeset_op( + tdsqlite3_changeset_iter *pIter, /* Iterator object */ + const char **pzTab, /* OUT: Pointer to table name */ + int *pnCol, /* OUT: Number of columns in table */ + int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */ + int *pbIndirect /* OUT: True for an 'indirect' change */ +); + +/* +** CAPI3REF: Obtain The Primary Key Definition Of A Table +** METHOD: tdsqlite3_changeset_iter +** +** For each modified table, a changeset includes the following: +** +**
    +**
  • The number of columns in the table, and +**
  • Which of those columns make up the tables PRIMARY KEY. +**
+** +** This function is used to find which columns comprise the PRIMARY KEY of +** the table modified by the change that iterator pIter currently points to. +** If successful, *pabPK is set to point to an array of nCol entries, where +** nCol is the number of columns in the table. Elements of *pabPK are set to +** 0x01 if the corresponding column is part of the tables primary key, or +** 0x00 if it is not. +** +** If argument pnCol is not NULL, then *pnCol is set to the number of columns +** in the table. +** +** If this function is called when the iterator does not point to a valid +** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise, +** SQLITE_OK is returned and the output variables populated as described +** above. +*/ +SQLITE_API int tdsqlite3changeset_pk( + tdsqlite3_changeset_iter *pIter, /* Iterator object */ + unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */ + int *pnCol /* OUT: Number of entries in output array */ +); + +/* +** CAPI3REF: Obtain old.* Values From A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** The pIter argument passed to this function may either be an iterator +** passed to a conflict-handler by [tdsqlite3changeset_apply()], or an iterator +** created by [tdsqlite3changeset_start()]. In the latter case, the most recent +** call to [tdsqlite3changeset_next()] must have returned SQLITE_ROW. +** Furthermore, it may only be called if the type of change that the iterator +** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise, +** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL. +** +** Argument iVal must be greater than or equal to 0, and less than the number +** of columns in the table affected by the current change. Otherwise, +** [SQLITE_RANGE] is returned and *ppValue is set to NULL. +** +** If successful, this function sets *ppValue to point to a protected +** tdsqlite3_value object containing the iVal'th value from the vector of +** original row values stored as part of the UPDATE or DELETE change and +** returns SQLITE_OK. The name of the function comes from the fact that this +** is similar to the "old.*" columns available to update or delete triggers. +** +** If some other error occurs (e.g. an OOM condition), an SQLite error code +** is returned and *ppValue is set to NULL. +*/ +SQLITE_API int tdsqlite3changeset_old( + tdsqlite3_changeset_iter *pIter, /* Changeset iterator */ + int iVal, /* Column number */ + tdsqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */ +); + +/* +** CAPI3REF: Obtain new.* Values From A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** The pIter argument passed to this function may either be an iterator +** passed to a conflict-handler by [tdsqlite3changeset_apply()], or an iterator +** created by [tdsqlite3changeset_start()]. In the latter case, the most recent +** call to [tdsqlite3changeset_next()] must have returned SQLITE_ROW. +** Furthermore, it may only be called if the type of change that the iterator +** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise, +** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL. +** +** Argument iVal must be greater than or equal to 0, and less than the number +** of columns in the table affected by the current change. Otherwise, +** [SQLITE_RANGE] is returned and *ppValue is set to NULL. +** +** If successful, this function sets *ppValue to point to a protected +** tdsqlite3_value object containing the iVal'th value from the vector of +** new row values stored as part of the UPDATE or INSERT change and +** returns SQLITE_OK. If the change is an UPDATE and does not include +** a new value for the requested column, *ppValue is set to NULL and +** SQLITE_OK returned. The name of the function comes from the fact that +** this is similar to the "new.*" columns available to update or delete +** triggers. +** +** If some other error occurs (e.g. an OOM condition), an SQLite error code +** is returned and *ppValue is set to NULL. +*/ +SQLITE_API int tdsqlite3changeset_new( + tdsqlite3_changeset_iter *pIter, /* Changeset iterator */ + int iVal, /* Column number */ + tdsqlite3_value **ppValue /* OUT: New value (or NULL pointer) */ +); + +/* +** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** This function should only be used with iterator objects passed to a +** conflict-handler callback by [tdsqlite3changeset_apply()] with either +** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function +** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue +** is set to NULL. +** +** Argument iVal must be greater than or equal to 0, and less than the number +** of columns in the table affected by the current change. Otherwise, +** [SQLITE_RANGE] is returned and *ppValue is set to NULL. +** +** If successful, this function sets *ppValue to point to a protected +** tdsqlite3_value object containing the iVal'th value from the +** "conflicting row" associated with the current conflict-handler callback +** and returns SQLITE_OK. +** +** If some other error occurs (e.g. an OOM condition), an SQLite error code +** is returned and *ppValue is set to NULL. +*/ +SQLITE_API int tdsqlite3changeset_conflict( + tdsqlite3_changeset_iter *pIter, /* Changeset iterator */ + int iVal, /* Column number */ + tdsqlite3_value **ppValue /* OUT: Value from conflicting row */ +); + +/* +** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations +** METHOD: tdsqlite3_changeset_iter +** +** This function may only be called with an iterator passed to an +** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case +** it sets the output variable to the total number of known foreign key +** violations in the destination database and returns SQLITE_OK. +** +** In all other cases this function returns SQLITE_MISUSE. +*/ +SQLITE_API int tdsqlite3changeset_fk_conflicts( + tdsqlite3_changeset_iter *pIter, /* Changeset iterator */ + int *pnOut /* OUT: Number of FK violations */ +); + + +/* +** CAPI3REF: Finalize A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** This function is used to finalize an iterator allocated with +** [tdsqlite3changeset_start()]. +** +** This function should only be called on iterators created using the +** [tdsqlite3changeset_start()] function. If an application calls this +** function with an iterator passed to a conflict-handler by +** [tdsqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the +** call has no effect. +** +** If an error was encountered within a call to an tdsqlite3changeset_xxx() +** function (for example an [SQLITE_CORRUPT] in [tdsqlite3changeset_next()] or an +** [SQLITE_NOMEM] in [tdsqlite3changeset_new()]) then an error code corresponding +** to that error is returned by this function. Otherwise, SQLITE_OK is +** returned. This is to allow the following pattern (pseudo-code): +** +** 
+**   tdsqlite3changeset_start();
+**   while( SQLITE_ROW==tdsqlite3changeset_next() ){
+**     // Do something with change.
+**   }
+**   rc = tdsqlite3changeset_finalize();
+**   if( rc!=SQLITE_OK ){
+**     // An error has occurred 
+**   }
+**
+*/ +SQLITE_API int tdsqlite3changeset_finalize(tdsqlite3_changeset_iter *pIter); + +/* +** CAPI3REF: Invert A Changeset +** +** This function is used to "invert" a changeset object. Applying an inverted +** changeset to a database reverses the effects of applying the uninverted +** changeset. Specifically: +** +**
    +**
  • Each DELETE change is changed to an INSERT, and +**
  • Each INSERT change is changed to a DELETE, and +**
  • For each UPDATE change, the old.* and new.* values are exchanged. +**
+** +** This function does not change the order in which changes appear within +** the changeset. It merely reverses the sense of each individual change. +** +** If successful, a pointer to a buffer containing the inverted changeset +** is stored in *ppOut, the size of the same buffer is stored in *pnOut, and +** SQLITE_OK is returned. If an error occurs, both *pnOut and *ppOut are +** zeroed and an SQLite error code returned. +** +** It is the responsibility of the caller to eventually call tdsqlite3_free() +** on the *ppOut pointer to free the buffer allocation following a successful +** call to this function. +** +** WARNING/TODO: This function currently assumes that the input is a valid +** changeset. If it is not, the results are undefined. +*/ +SQLITE_API int tdsqlite3changeset_invert( + int nIn, const void *pIn, /* Input changeset */ + int *pnOut, void **ppOut /* OUT: Inverse of input */ +); + +/* +** CAPI3REF: Concatenate Two Changeset Objects +** +** This function is used to concatenate two changesets, A and B, into a +** single changeset. The result is a changeset equivalent to applying +** changeset A followed by changeset B. +** +** This function combines the two input changesets using an +** tdsqlite3_changegroup object. Calling it produces similar results as the +** following code fragment: +** +** 
+**   tdsqlite3_changegroup *pGrp;
+**   rc = tdsqlite3_changegroup_new(&pGrp);
+**   if( rc==SQLITE_OK ) rc = tdsqlite3changegroup_add(pGrp, nA, pA);
+**   if( rc==SQLITE_OK ) rc = tdsqlite3changegroup_add(pGrp, nB, pB);
+**   if( rc==SQLITE_OK ){
+**     rc = tdsqlite3changegroup_output(pGrp, pnOut, ppOut);
+**   }else{
+**     *ppOut = 0;
+**     *pnOut = 0;
+**   }
+**
+** +** Refer to the tdsqlite3_changegroup documentation below for details. +*/ +SQLITE_API int tdsqlite3changeset_concat( + int nA, /* Number of bytes in buffer pA */ + void *pA, /* Pointer to buffer containing changeset A */ + int nB, /* Number of bytes in buffer pB */ + void *pB, /* Pointer to buffer containing changeset B */ + int *pnOut, /* OUT: Number of bytes in output changeset */ + void **ppOut /* OUT: Buffer containing output changeset */ +); + + +/* +** CAPI3REF: Changegroup Handle +** +** A changegroup is an object used to combine two or more +** [changesets] or [patchsets] +*/ +typedef struct tdsqlite3_changegroup tdsqlite3_changegroup; + +/* +** CAPI3REF: Create A New Changegroup Object +** CONSTRUCTOR: tdsqlite3_changegroup +** +** An tdsqlite3_changegroup object is used to combine two or more changesets +** (or patchsets) into a single changeset (or patchset). A single changegroup +** object may combine changesets or patchsets, but not both. The output is +** always in the same format as the input. +** +** If successful, this function returns SQLITE_OK and populates (*pp) with +** a pointer to a new tdsqlite3_changegroup object before returning. The caller +** should eventually free the returned object using a call to +** tdsqlite3changegroup_delete(). If an error occurs, an SQLite error code +** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL. +** +** The usual usage pattern for an tdsqlite3_changegroup object is as follows: +** +**
    +**
  • It is created using a call to tdsqlite3changegroup_new(). +** +**
  • Zero or more changesets (or patchsets) are added to the object +** by calling tdsqlite3changegroup_add(). +** +**
  • The result of combining all input changesets together is obtained +** by the application via a call to tdsqlite3changegroup_output(). +** +**
  • The object is deleted using a call to tdsqlite3changegroup_delete(). +**
+** +** Any number of calls to add() and output() may be made between the calls to +** new() and delete(), and in any order. +** +** As well as the regular tdsqlite3changegroup_add() and +** tdsqlite3changegroup_output() functions, also available are the streaming +** versions tdsqlite3changegroup_add_strm() and tdsqlite3changegroup_output_strm(). +*/ +SQLITE_API int tdsqlite3changegroup_new(tdsqlite3_changegroup **pp); + +/* +** CAPI3REF: Add A Changeset To A Changegroup +** METHOD: tdsqlite3_changegroup +** +** Add all changes within the changeset (or patchset) in buffer pData (size +** nData bytes) to the changegroup. +** +** If the buffer contains a patchset, then all prior calls to this function +** on the same changegroup object must also have specified patchsets. Or, if +** the buffer contains a changeset, so must have the earlier calls to this +** function. Otherwise, SQLITE_ERROR is returned and no changes are added +** to the changegroup. +** +** Rows within the changeset and changegroup are identified by the values in +** their PRIMARY KEY columns. A change in the changeset is considered to +** apply to the same row as a change already present in the changegroup if +** the two rows have the same primary key. +** +** Changes to rows that do not already appear in the changegroup are +** simply copied into it. Or, if both the new changeset and the changegroup +** contain changes that apply to a single row, the final contents of the +** changegroup depends on the type of each change, as follows: +** +** +** +** +**
Existing Change New Change Output Change +**
INSERT INSERT +** The new change is ignored. This case does not occur if the new +** changeset was recorded immediately after the changesets already +** added to the changegroup. +**
INSERT UPDATE +** The INSERT change remains in the changegroup. The values in the +** INSERT change are modified as if the row was inserted by the +** existing change and then updated according to the new change. +**
INSERT DELETE +** The existing INSERT is removed from the changegroup. The DELETE is +** not added. +**
UPDATE INSERT +** The new change is ignored. This case does not occur if the new +** changeset was recorded immediately after the changesets already +** added to the changegroup. +**
UPDATE UPDATE +** The existing UPDATE remains within the changegroup. It is amended +** so that the accompanying values are as if the row was updated once +** by the existing change and then again by the new change. +**
UPDATE DELETE +** The existing UPDATE is replaced by the new DELETE within the +** changegroup. +**
DELETE INSERT +** If one or more of the column values in the row inserted by the +** new change differ from those in the row deleted by the existing +** change, the existing DELETE is replaced by an UPDATE within the +** changegroup. Otherwise, if the inserted row is exactly the same +** as the deleted row, the existing DELETE is simply discarded. +**
DELETE UPDATE +** The new change is ignored. This case does not occur if the new +** changeset was recorded immediately after the changesets already +** added to the changegroup. +**
DELETE DELETE +** The new change is ignored. This case does not occur if the new +** changeset was recorded immediately after the changesets already +** added to the changegroup. +**
+** +** If the new changeset contains changes to a table that is already present +** in the changegroup, then the number of columns and the position of the +** primary key columns for the table must be consistent. If this is not the +** case, this function fails with SQLITE_SCHEMA. If the input changeset +** appears to be corrupt and the corruption is detected, SQLITE_CORRUPT is +** returned. Or, if an out-of-memory condition occurs during processing, this +** function returns SQLITE_NOMEM. In all cases, if an error occurs the state +** of the final contents of the changegroup is undefined. +** +** If no error occurs, SQLITE_OK is returned. +*/ +SQLITE_API int tdsqlite3changegroup_add(tdsqlite3_changegroup*, int nData, void *pData); + +/* +** CAPI3REF: Obtain A Composite Changeset From A Changegroup +** METHOD: tdsqlite3_changegroup +** +** Obtain a buffer containing a changeset (or patchset) representing the +** current contents of the changegroup. If the inputs to the changegroup +** were themselves changesets, the output is a changeset. Or, if the +** inputs were patchsets, the output is also a patchset. +** +** As with the output of the tdsqlite3session_changeset() and +** tdsqlite3session_patchset() functions, all changes related to a single +** table are grouped together in the output of this function. Tables appear +** in the same order as for the very first changeset added to the changegroup. +** If the second or subsequent changesets added to the changegroup contain +** changes for tables that do not appear in the first changeset, they are +** appended onto the end of the output changeset, again in the order in +** which they are first encountered. +** +** If an error occurs, an SQLite error code is returned and the output +** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK +** is returned and the output variables are set to the size of and a +** pointer to the output buffer, respectively. In this case it is the +** responsibility of the caller to eventually free the buffer using a +** call to tdsqlite3_free(). +*/ +SQLITE_API int tdsqlite3changegroup_output( + tdsqlite3_changegroup*, + int *pnData, /* OUT: Size of output buffer in bytes */ + void **ppData /* OUT: Pointer to output buffer */ +); + +/* +** CAPI3REF: Delete A Changegroup Object +** DESTRUCTOR: tdsqlite3_changegroup +*/ +SQLITE_API void tdsqlite3changegroup_delete(tdsqlite3_changegroup*); + +/* +** CAPI3REF: Apply A Changeset To A Database +** +** Apply a changeset or patchset to a database. These functions attempt to +** update the "main" database attached to handle db with the changes found in +** the changeset passed via the second and third arguments. +** +** The fourth argument (xFilter) passed to these functions is the "filter +** callback". If it is not NULL, then for each table affected by at least one +** change in the changeset, the filter callback is invoked with +** the table name as the second argument, and a copy of the context pointer +** passed as the sixth argument as the first. If the "filter callback" +** returns zero, then no attempt is made to apply any changes to the table. +** Otherwise, if the return value is non-zero or the xFilter argument to +** is NULL, all changes related to the table are attempted. +** +** For each table that is not excluded by the filter callback, this function +** tests that the target database contains a compatible table. A table is +** considered compatible if all of the following are true: +** +**
    +**
  • The table has the same name as the name recorded in the +** changeset, and +**
  • The table has at least as many columns as recorded in the +** changeset, and +**
  • The table has primary key columns in the same position as +** recorded in the changeset. +**
+** +** If there is no compatible table, it is not an error, but none of the +** changes associated with the table are applied. A warning message is issued +** via the tdsqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most +** one such warning is issued for each table in the changeset. +** +** For each change for which there is a compatible table, an attempt is made +** to modify the table contents according to the UPDATE, INSERT or DELETE +** change. If a change cannot be applied cleanly, the conflict handler +** function passed as the fifth argument to tdsqlite3changeset_apply() may be +** invoked. A description of exactly when the conflict handler is invoked for +** each type of change is below. +** +** Unlike the xFilter argument, xConflict may not be passed NULL. The results +** of passing anything other than a valid function pointer as the xConflict +** argument are undefined. +** +** Each time the conflict handler function is invoked, it must return one +** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or +** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned +** if the second argument passed to the conflict handler is either +** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler +** returns an illegal value, any changes already made are rolled back and +** the call to tdsqlite3changeset_apply() returns SQLITE_MISUSE. Different +** actions are taken by tdsqlite3changeset_apply() depending on the value +** returned by each invocation of the conflict-handler function. Refer to +** the documentation for the three +** [SQLITE_CHANGESET_OMIT|available return values] for details. +** +**
+**
DELETE Changes
+** For each DELETE change, the function checks if the target database +** contains a row with the same primary key value (or values) as the +** original row values stored in the changeset. If it does, and the values +** stored in all non-primary key columns also match the values stored in +** the changeset the row is deleted from the target database. +** +** If a row with matching primary key values is found, but one or more of +** the non-primary key fields contains a value different from the original +** row value stored in the changeset, the conflict-handler function is +** invoked with [SQLITE_CHANGESET_DATA] as the second argument. If the +** database table has more columns than are recorded in the changeset, +** only the values of those non-primary key fields are compared against +** the current database contents - any trailing database table columns +** are ignored. +** +** If no row with matching primary key values is found in the database, +** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND] +** passed as the second argument. +** +** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT +** (which can only happen if a foreign key constraint is violated), the +** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT] +** passed as the second argument. This includes the case where the DELETE +** operation is attempted because an earlier call to the conflict handler +** function returned [SQLITE_CHANGESET_REPLACE]. +** +**
INSERT Changes
+** For each INSERT change, an attempt is made to insert the new row into +** the database. If the changeset row contains fewer fields than the +** database table, the trailing fields are populated with their default +** values. +** +** If the attempt to insert the row fails because the database already +** contains a row with the same primary key values, the conflict handler +** function is invoked with the second argument set to +** [SQLITE_CHANGESET_CONFLICT]. +** +** If the attempt to insert the row fails because of some other constraint +** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is +** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT]. +** This includes the case where the INSERT operation is re-attempted because +** an earlier call to the conflict handler function returned +** [SQLITE_CHANGESET_REPLACE]. +** +**
UPDATE Changes
+** For each UPDATE change, the function checks if the target database +** contains a row with the same primary key value (or values) as the +** original row values stored in the changeset. If it does, and the values +** stored in all modified non-primary key columns also match the values +** stored in the changeset the row is updated within the target database. +** +** If a row with matching primary key values is found, but one or more of +** the modified non-primary key fields contains a value different from an +** original row value stored in the changeset, the conflict-handler function +** is invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since +** UPDATE changes only contain values for non-primary key fields that are +** to be modified, only those fields need to match the original values to +** avoid the SQLITE_CHANGESET_DATA conflict-handler callback. +** +** If no row with matching primary key values is found in the database, +** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND] +** passed as the second argument. +** +** If the UPDATE operation is attempted, but SQLite returns +** SQLITE_CONSTRAINT, the conflict-handler function is invoked with +** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument. +** This includes the case where the UPDATE operation is attempted after +** an earlier call to the conflict handler function returned +** [SQLITE_CHANGESET_REPLACE]. +**
+** +** It is safe to execute SQL statements, including those that write to the +** table that the callback related to, from within the xConflict callback. +** This can be used to further customize the application's conflict +** resolution strategy. +** +** All changes made by these functions are enclosed in a savepoint transaction. +** If any other error (aside from a constraint failure when attempting to +** write to the target database) occurs, then the savepoint transaction is +** rolled back, restoring the target database to its original state, and an +** SQLite error code returned. +** +** If the output parameters (ppRebase) and (pnRebase) are non-NULL and +** the input is a changeset (not a patchset), then tdsqlite3changeset_apply_v2() +** may set (*ppRebase) to point to a "rebase" that may be used with the +** tdsqlite3_rebaser APIs buffer before returning. In this case (*pnRebase) +** is set to the size of the buffer in bytes. It is the responsibility of the +** caller to eventually free any such buffer using tdsqlite3_free(). The buffer +** is only allocated and populated if one or more conflicts were encountered +** while applying the patchset. See comments surrounding the tdsqlite3_rebaser +** APIs for further details. +** +** The behavior of tdsqlite3changeset_apply_v2() and its streaming equivalent +** may be modified by passing a combination of +** [SQLITE_CHANGESETAPPLY_NOSAVEPOINT | supported flags] as the 9th parameter. +** +** Note that the tdsqlite3changeset_apply_v2() API is still experimental +** and therefore subject to change. +*/ +SQLITE_API int tdsqlite3changeset_apply( + tdsqlite3 *db, /* Apply change to "main" db of this handle */ + int nChangeset, /* Size of changeset in bytes */ + void *pChangeset, /* Changeset blob */ + int(*xFilter)( + void *pCtx, /* Copy of sixth arg to _apply() */ + const char *zTab /* Table name */ + ), + int(*xConflict)( + void *pCtx, /* Copy of sixth arg to _apply() */ + int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ + tdsqlite3_changeset_iter *p /* Handle describing change and conflict */ + ), + void *pCtx /* First argument passed to xConflict */ +); +SQLITE_API int tdsqlite3changeset_apply_v2( + tdsqlite3 *db, /* Apply change to "main" db of this handle */ + int nChangeset, /* Size of changeset in bytes */ + void *pChangeset, /* Changeset blob */ + int(*xFilter)( + void *pCtx, /* Copy of sixth arg to _apply() */ + const char *zTab /* Table name */ + ), + int(*xConflict)( + void *pCtx, /* Copy of sixth arg to _apply() */ + int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ + tdsqlite3_changeset_iter *p /* Handle describing change and conflict */ + ), + void *pCtx, /* First argument passed to xConflict */ + void **ppRebase, int *pnRebase, /* OUT: Rebase data */ + int flags /* SESSION_CHANGESETAPPLY_* flags */ +); + +/* +** CAPI3REF: Flags for tdsqlite3changeset_apply_v2 +** +** The following flags may passed via the 9th parameter to +** [tdsqlite3changeset_apply_v2] and [tdsqlite3changeset_apply_v2_strm]: +** +**
+**
SQLITE_CHANGESETAPPLY_NOSAVEPOINT
+** Usually, the sessions module encloses all operations performed by +** a single call to apply_v2() or apply_v2_strm() in a [SAVEPOINT]. The +** SAVEPOINT is committed if the changeset or patchset is successfully +** applied, or rolled back if an error occurs. Specifying this flag +** causes the sessions module to omit this savepoint. In this case, if the +** caller has an open transaction or savepoint when apply_v2() is called, +** it may revert the partially applied changeset by rolling it back. +** +**
SQLITE_CHANGESETAPPLY_INVERT
+** Invert the changeset before applying it. This is equivalent to inverting +** a changeset using tdsqlite3changeset_invert() before applying it. It is +** an error to specify this flag with a patchset. +*/ +#define SQLITE_CHANGESETAPPLY_NOSAVEPOINT 0x0001 +#define SQLITE_CHANGESETAPPLY_INVERT 0x0002 + +/* +** CAPI3REF: Constants Passed To The Conflict Handler +** +** Values that may be passed as the second argument to a conflict-handler. +** +**
+**
SQLITE_CHANGESET_DATA
+** The conflict handler is invoked with CHANGESET_DATA as the second argument +** when processing a DELETE or UPDATE change if a row with the required +** PRIMARY KEY fields is present in the database, but one or more other +** (non primary-key) fields modified by the update do not contain the +** expected "before" values. +** +** The conflicting row, in this case, is the database row with the matching +** primary key. +** +**
SQLITE_CHANGESET_NOTFOUND
+** The conflict handler is invoked with CHANGESET_NOTFOUND as the second +** argument when processing a DELETE or UPDATE change if a row with the +** required PRIMARY KEY fields is not present in the database. +** +** There is no conflicting row in this case. The results of invoking the +** tdsqlite3changeset_conflict() API are undefined. +** +**
SQLITE_CHANGESET_CONFLICT
+** CHANGESET_CONFLICT is passed as the second argument to the conflict +** handler while processing an INSERT change if the operation would result +** in duplicate primary key values. +** +** The conflicting row in this case is the database row with the matching +** primary key. +** +**
SQLITE_CHANGESET_FOREIGN_KEY
+** If foreign key handling is enabled, and applying a changeset leaves the +** database in a state containing foreign key violations, the conflict +** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument +** exactly once before the changeset is committed. If the conflict handler +** returns CHANGESET_OMIT, the changes, including those that caused the +** foreign key constraint violation, are committed. Or, if it returns +** CHANGESET_ABORT, the changeset is rolled back. +** +** No current or conflicting row information is provided. The only function +** it is possible to call on the supplied tdsqlite3_changeset_iter handle +** is tdsqlite3changeset_fk_conflicts(). +** +**
SQLITE_CHANGESET_CONSTRAINT
+** If any other constraint violation occurs while applying a change (i.e. +** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is +** invoked with CHANGESET_CONSTRAINT as the second argument. +** +** There is no conflicting row in this case. The results of invoking the +** tdsqlite3changeset_conflict() API are undefined. +** +**
+*/ +#define SQLITE_CHANGESET_DATA 1 +#define SQLITE_CHANGESET_NOTFOUND 2 +#define SQLITE_CHANGESET_CONFLICT 3 +#define SQLITE_CHANGESET_CONSTRAINT 4 +#define SQLITE_CHANGESET_FOREIGN_KEY 5 + +/* +** CAPI3REF: Constants Returned By The Conflict Handler +** +** A conflict handler callback must return one of the following three values. +** +**
+**
SQLITE_CHANGESET_OMIT
+** If a conflict handler returns this value no special action is taken. The +** change that caused the conflict is not applied. The session module +** continues to the next change in the changeset. +** +**
SQLITE_CHANGESET_REPLACE
+** This value may only be returned if the second argument to the conflict +** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this +** is not the case, any changes applied so far are rolled back and the +** call to tdsqlite3changeset_apply() returns SQLITE_MISUSE. +** +** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict +** handler, then the conflicting row is either updated or deleted, depending +** on the type of change. +** +** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict +** handler, then the conflicting row is removed from the database and a +** second attempt to apply the change is made. If this second attempt fails, +** the original row is restored to the database before continuing. +** +**
SQLITE_CHANGESET_ABORT
+** If this value is returned, any changes applied so far are rolled back +** and the call to tdsqlite3changeset_apply() returns SQLITE_ABORT. +**
+*/ +#define SQLITE_CHANGESET_OMIT 0 +#define SQLITE_CHANGESET_REPLACE 1 +#define SQLITE_CHANGESET_ABORT 2 + +/* +** CAPI3REF: Rebasing changesets +** EXPERIMENTAL +** +** Suppose there is a site hosting a database in state S0. And that +** modifications are made that move that database to state S1 and a +** changeset recorded (the "local" changeset). Then, a changeset based +** on S0 is received from another site (the "remote" changeset) and +** applied to the database. The database is then in state +** (S1+"remote"), where the exact state depends on any conflict +** resolution decisions (OMIT or REPLACE) made while applying "remote". +** Rebasing a changeset is to update it to take those conflict +** resolution decisions into account, so that the same conflicts +** do not have to be resolved elsewhere in the network. +** +** For example, if both the local and remote changesets contain an +** INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)": +** +** local: INSERT INTO t1 VALUES(1, 'v1'); +** remote: INSERT INTO t1 VALUES(1, 'v2'); +** +** and the conflict resolution is REPLACE, then the INSERT change is +** removed from the local changeset (it was overridden). Or, if the +** conflict resolution was "OMIT", then the local changeset is modified +** to instead contain: +** +** UPDATE t1 SET b = 'v2' WHERE a=1; +** +** Changes within the local changeset are rebased as follows: +** +**
+**
Local INSERT
+** This may only conflict with a remote INSERT. If the conflict +** resolution was OMIT, then add an UPDATE change to the rebased +** changeset. Or, if the conflict resolution was REPLACE, add +** nothing to the rebased changeset. +** +**
Local DELETE
+** This may conflict with a remote UPDATE or DELETE. In both cases the +** only possible resolution is OMIT. If the remote operation was a +** DELETE, then add no change to the rebased changeset. If the remote +** operation was an UPDATE, then the old.* fields of change are updated +** to reflect the new.* values in the UPDATE. +** +**
Local UPDATE
+** This may conflict with a remote UPDATE or DELETE. If it conflicts +** with a DELETE, and the conflict resolution was OMIT, then the update +** is changed into an INSERT. Any undefined values in the new.* record +** from the update change are filled in using the old.* values from +** the conflicting DELETE. Or, if the conflict resolution was REPLACE, +** the UPDATE change is simply omitted from the rebased changeset. +** +** If conflict is with a remote UPDATE and the resolution is OMIT, then +** the old.* values are rebased using the new.* values in the remote +** change. Or, if the resolution is REPLACE, then the change is copied +** into the rebased changeset with updates to columns also updated by +** the conflicting remote UPDATE removed. If this means no columns would +** be updated, the change is omitted. +**
+** +** A local change may be rebased against multiple remote changes +** simultaneously. If a single key is modified by multiple remote +** changesets, they are combined as follows before the local changeset +** is rebased: +** +**
    +**
  • If there has been one or more REPLACE resolutions on a +** key, it is rebased according to a REPLACE. +** +**
  • If there have been no REPLACE resolutions on a key, then +** the local changeset is rebased according to the most recent +** of the OMIT resolutions. +**
+** +** Note that conflict resolutions from multiple remote changesets are +** combined on a per-field basis, not per-row. This means that in the +** case of multiple remote UPDATE operations, some fields of a single +** local change may be rebased for REPLACE while others are rebased for +** OMIT. +** +** In order to rebase a local changeset, the remote changeset must first +** be applied to the local database using tdsqlite3changeset_apply_v2() and +** the buffer of rebase information captured. Then: +** +**
    +**
  1. An tdsqlite3_rebaser object is created by calling +** tdsqlite3rebaser_create(). +**
  2. The new object is configured with the rebase buffer obtained from +** tdsqlite3changeset_apply_v2() by calling tdsqlite3rebaser_configure(). +** If the local changeset is to be rebased against multiple remote +** changesets, then tdsqlite3rebaser_configure() should be called +** multiple times, in the same order that the multiple +** tdsqlite3changeset_apply_v2() calls were made. +**
  3. Each local changeset is rebased by calling tdsqlite3rebaser_rebase(). +**
  4. The tdsqlite3_rebaser object is deleted by calling +** tdsqlite3rebaser_delete(). +**
+*/ +typedef struct tdsqlite3_rebaser tdsqlite3_rebaser; + +/* +** CAPI3REF: Create a changeset rebaser object. +** EXPERIMENTAL +** +** Allocate a new changeset rebaser object. If successful, set (*ppNew) to +** point to the new object and return SQLITE_OK. Otherwise, if an error +** occurs, return an SQLite error code (e.g. SQLITE_NOMEM) and set (*ppNew) +** to NULL. +*/ +SQLITE_API int tdsqlite3rebaser_create(tdsqlite3_rebaser **ppNew); + +/* +** CAPI3REF: Configure a changeset rebaser object. +** EXPERIMENTAL +** +** Configure the changeset rebaser object to rebase changesets according +** to the conflict resolutions described by buffer pRebase (size nRebase +** bytes), which must have been obtained from a previous call to +** tdsqlite3changeset_apply_v2(). +*/ +SQLITE_API int tdsqlite3rebaser_configure( + tdsqlite3_rebaser*, + int nRebase, const void *pRebase +); + +/* +** CAPI3REF: Rebase a changeset +** EXPERIMENTAL +** +** Argument pIn must point to a buffer containing a changeset nIn bytes +** in size. This function allocates and populates a buffer with a copy +** of the changeset rebased according to the configuration of the +** rebaser object passed as the first argument. If successful, (*ppOut) +** is set to point to the new buffer containing the rebased changeset and +** (*pnOut) to its size in bytes and SQLITE_OK returned. It is the +** responsibility of the caller to eventually free the new buffer using +** tdsqlite3_free(). Otherwise, if an error occurs, (*ppOut) and (*pnOut) +** are set to zero and an SQLite error code returned. +*/ +SQLITE_API int tdsqlite3rebaser_rebase( + tdsqlite3_rebaser*, + int nIn, const void *pIn, + int *pnOut, void **ppOut +); + +/* +** CAPI3REF: Delete a changeset rebaser object. +** EXPERIMENTAL +** +** Delete the changeset rebaser object and all associated resources. There +** should be one call to this function for each successful invocation +** of tdsqlite3rebaser_create(). +*/ +SQLITE_API void tdsqlite3rebaser_delete(tdsqlite3_rebaser *p); + +/* +** CAPI3REF: Streaming Versions of API functions. +** +** The six streaming API xxx_strm() functions serve similar purposes to the +** corresponding non-streaming API functions: +** +** +** +**
Streaming functionNon-streaming equivalent
tdsqlite3changeset_apply_strm[tdsqlite3changeset_apply] +**
tdsqlite3changeset_apply_strm_v2[tdsqlite3changeset_apply_v2] +**
tdsqlite3changeset_concat_strm[tdsqlite3changeset_concat] +**
tdsqlite3changeset_invert_strm[tdsqlite3changeset_invert] +**
tdsqlite3changeset_start_strm[tdsqlite3changeset_start] +**
tdsqlite3session_changeset_strm[tdsqlite3session_changeset] +**
tdsqlite3session_patchset_strm[tdsqlite3session_patchset] +**
+** +** Non-streaming functions that accept changesets (or patchsets) as input +** require that the entire changeset be stored in a single buffer in memory. +** Similarly, those that return a changeset or patchset do so by returning +** a pointer to a single large buffer allocated using tdsqlite3_malloc(). +** Normally this is convenient. However, if an application running in a +** low-memory environment is required to handle very large changesets, the +** large contiguous memory allocations required can become onerous. +** +** In order to avoid this problem, instead of a single large buffer, input +** is passed to a streaming API functions by way of a callback function that +** the sessions module invokes to incrementally request input data as it is +** required. In all cases, a pair of API function parameters such as +** +** 
+**        int nChangeset,
+**        void *pChangeset,
+**
+** +** Is replaced by: +** +** 
+**        int (*xInput)(void *pIn, void *pData, int *pnData),
+**        void *pIn,
+**
+** +** Each time the xInput callback is invoked by the sessions module, the first +** argument passed is a copy of the supplied pIn context pointer. The second +** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no +** error occurs the xInput method should copy up to (*pnData) bytes of data +** into the buffer and set (*pnData) to the actual number of bytes copied +** before returning SQLITE_OK. If the input is completely exhausted, (*pnData) +** should be set to zero to indicate this. Or, if an error occurs, an SQLite +** error code should be returned. In all cases, if an xInput callback returns +** an error, all processing is abandoned and the streaming API function +** returns a copy of the error code to the caller. +** +** In the case of tdsqlite3changeset_start_strm(), the xInput callback may be +** invoked by the sessions module at any point during the lifetime of the +** iterator. If such an xInput callback returns an error, the iterator enters +** an error state, whereby all subsequent calls to iterator functions +** immediately fail with the same error code as returned by xInput. +** +** Similarly, streaming API functions that return changesets (or patchsets) +** return them in chunks by way of a callback function instead of via a +** pointer to a single large buffer. In this case, a pair of parameters such +** as: +** +** 
+**        int *pnChangeset,
+**        void **ppChangeset,
+**
+** +** Is replaced by: +** +** 
+**        int (*xOutput)(void *pOut, const void *pData, int nData),
+**        void *pOut
+**
+** +** The xOutput callback is invoked zero or more times to return data to +** the application. The first parameter passed to each call is a copy of the +** pOut pointer supplied by the application. The second parameter, pData, +** points to a buffer nData bytes in size containing the chunk of output +** data being returned. If the xOutput callback successfully processes the +** supplied data, it should return SQLITE_OK to indicate success. Otherwise, +** it should return some other SQLite error code. In this case processing +** is immediately abandoned and the streaming API function returns a copy +** of the xOutput error code to the application. +** +** The sessions module never invokes an xOutput callback with the third +** parameter set to a value less than or equal to zero. Other than this, +** no guarantees are made as to the size of the chunks of data returned. +*/ +SQLITE_API int tdsqlite3changeset_apply_strm( + tdsqlite3 *db, /* Apply change to "main" db of this handle */ + int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */ + void *pIn, /* First arg for xInput */ + int(*xFilter)( + void *pCtx, /* Copy of sixth arg to _apply() */ + const char *zTab /* Table name */ + ), + int(*xConflict)( + void *pCtx, /* Copy of sixth arg to _apply() */ + int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ + tdsqlite3_changeset_iter *p /* Handle describing change and conflict */ + ), + void *pCtx /* First argument passed to xConflict */ +); +SQLITE_API int tdsqlite3changeset_apply_v2_strm( + tdsqlite3 *db, /* Apply change to "main" db of this handle */ + int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */ + void *pIn, /* First arg for xInput */ + int(*xFilter)( + void *pCtx, /* Copy of sixth arg to _apply() */ + const char *zTab /* Table name */ + ), + int(*xConflict)( + void *pCtx, /* Copy of sixth arg to _apply() */ + int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ + tdsqlite3_changeset_iter *p /* Handle describing change and conflict */ + ), + void *pCtx, /* First argument passed to xConflict */ + void **ppRebase, int *pnRebase, + int flags +); +SQLITE_API int tdsqlite3changeset_concat_strm( + int (*xInputA)(void *pIn, void *pData, int *pnData), + void *pInA, + int (*xInputB)(void *pIn, void *pData, int *pnData), + void *pInB, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +SQLITE_API int tdsqlite3changeset_invert_strm( + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +SQLITE_API int tdsqlite3changeset_start_strm( + tdsqlite3_changeset_iter **pp, + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn +); +SQLITE_API int tdsqlite3changeset_start_v2_strm( + tdsqlite3_changeset_iter **pp, + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn, + int flags +); +SQLITE_API int tdsqlite3session_changeset_strm( + tdsqlite3_session *pSession, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +SQLITE_API int tdsqlite3session_patchset_strm( + tdsqlite3_session *pSession, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +SQLITE_API int tdsqlite3changegroup_add_strm(tdsqlite3_changegroup*, + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn +); +SQLITE_API int tdsqlite3changegroup_output_strm(tdsqlite3_changegroup*, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +SQLITE_API int tdsqlite3rebaser_rebase_strm( + tdsqlite3_rebaser *pRebaser, + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); + +/* +** CAPI3REF: Configure global parameters +** +** The tdsqlite3session_config() interface is used to make global configuration +** changes to the sessions module in order to tune it to the specific needs +** of the application. +** +** The tdsqlite3session_config() interface is not threadsafe. If it is invoked +** while any other thread is inside any other sessions method then the +** results are undefined. Furthermore, if it is invoked after any sessions +** related objects have been created, the results are also undefined. +** +** The first argument to the tdsqlite3session_config() function must be one +** of the SQLITE_SESSION_CONFIG_XXX constants defined below. The +** interpretation of the (void*) value passed as the second parameter and +** the effect of calling this function depends on the value of the first +** parameter. +** +**
+**
SQLITE_SESSION_CONFIG_STRMSIZE
+** By default, the sessions module streaming interfaces attempt to input +** and output data in approximately 1 KiB chunks. This operand may be used +** to set and query the value of this configuration setting. The pointer +** passed as the second argument must point to a value of type (int). +** If this value is greater than 0, it is used as the new streaming data +** chunk size for both input and output. Before returning, the (int) value +** pointed to by pArg is set to the final value of the streaming interface +** chunk size. +**
+** +** This function returns SQLITE_OK if successful, or an SQLite error code +** otherwise. +*/ +SQLITE_API int tdsqlite3session_config(int op, void *pArg); + +/* +** CAPI3REF: Values for tdsqlite3session_config(). +*/ +#define SQLITE_SESSION_CONFIG_STRMSIZE 1 + +/* +** Make sure we can call this stuff from C++. +*/ +#ifdef __cplusplus +} +#endif + +#endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */ + +/******** End of tdsqlite3session.h *********/ +/******** Begin file fts5.h *********/ +/* +** 2014 May 31 +** +** The author disclaims copyright to this source code. In place of +** a legal notice, here is a blessing: +** +** May you do good and not evil. +** May you find forgiveness for yourself and forgive others. +** May you share freely, never taking more than you give. +** +****************************************************************************** +** +** Interfaces to extend FTS5. Using the interfaces defined in this file, +** FTS5 may be extended with: +** +** * custom tokenizers, and +** * custom auxiliary functions. +*/ + + +#ifndef _FTS5_H +#define _FTS5_H + + +#ifdef __cplusplus +extern "C" { +#endif + +/************************************************************************* +** CUSTOM AUXILIARY FUNCTIONS +** +** Virtual table implementations may overload SQL functions by implementing +** the tdsqlite3_module.xFindFunction() method. +*/ + +typedef struct Fts5ExtensionApi Fts5ExtensionApi; +typedef struct Fts5Context Fts5Context; +typedef struct Fts5PhraseIter Fts5PhraseIter; + +typedef void (*fts5_extension_function)( + const Fts5ExtensionApi *pApi, /* API offered by current FTS version */ + Fts5Context *pFts, /* First arg to pass to pApi functions */ + tdsqlite3_context *pCtx, /* Context for returning result/error */ + int nVal, /* Number of values in apVal[] array */ + tdsqlite3_value **apVal /* Array of trailing arguments */ +); + +struct Fts5PhraseIter { + const unsigned char *a; + const unsigned char *b; +}; + +/* +** EXTENSION API FUNCTIONS +** +** xUserData(pFts): +** Return a copy of the context pointer the extension function was +** registered with. +** +** xColumnTotalSize(pFts, iCol, pnToken): +** If parameter iCol is less than zero, set output variable *pnToken +** to the total number of tokens in the FTS5 table. Or, if iCol is +** non-negative but less than the number of columns in the table, return +** the total number of tokens in column iCol, considering all rows in +** the FTS5 table. +** +** If parameter iCol is greater than or equal to the number of columns +** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g. +** an OOM condition or IO error), an appropriate SQLite error code is +** returned. +** +** xColumnCount(pFts): +** Return the number of columns in the table. +** +** xColumnSize(pFts, iCol, pnToken): +** If parameter iCol is less than zero, set output variable *pnToken +** to the total number of tokens in the current row. Or, if iCol is +** non-negative but less than the number of columns in the table, set +** *pnToken to the number of tokens in column iCol of the current row. +** +** If parameter iCol is greater than or equal to the number of columns +** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g. +** an OOM condition or IO error), an appropriate SQLite error code is +** returned. +** +** This function may be quite inefficient if used with an FTS5 table +** created with the "columnsize=0" option. +** +** xColumnText: +** This function attempts to retrieve the text of column iCol of the +** current document. If successful, (*pz) is set to point to a buffer +** containing the text in utf-8 encoding, (*pn) is set to the size in bytes +** (not characters) of the buffer and SQLITE_OK is returned. Otherwise, +** if an error occurs, an SQLite error code is returned and the final values +** of (*pz) and (*pn) are undefined. +** +** xPhraseCount: +** Returns the number of phrases in the current query expression. +** +** xPhraseSize: +** Returns the number of tokens in phrase iPhrase of the query. Phrases +** are numbered starting from zero. +** +** xInstCount: +** Set *pnInst to the total number of occurrences of all phrases within +** the query within the current row. Return SQLITE_OK if successful, or +** an error code (i.e. SQLITE_NOMEM) if an error occurs. +** +** This API can be quite slow if used with an FTS5 table created with the +** "detail=none" or "detail=column" option. If the FTS5 table is created +** with either "detail=none" or "detail=column" and "content=" option +** (i.e. if it is a contentless table), then this API always returns 0. +** +** xInst: +** Query for the details of phrase match iIdx within the current row. +** Phrase matches are numbered starting from zero, so the iIdx argument +** should be greater than or equal to zero and smaller than the value +** output by xInstCount(). +** +** Usually, output parameter *piPhrase is set to the phrase number, *piCol +** to the column in which it occurs and *piOff the token offset of the +** first token of the phrase. Returns SQLITE_OK if successful, or an error +** code (i.e. SQLITE_NOMEM) if an error occurs. +** +** This API can be quite slow if used with an FTS5 table created with the +** "detail=none" or "detail=column" option. +** +** xRowid: +** Returns the rowid of the current row. +** +** xTokenize: +** Tokenize text using the tokenizer belonging to the FTS5 table. +** +** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback): +** This API function is used to query the FTS table for phrase iPhrase +** of the current query. Specifically, a query equivalent to: +** +** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid +** +** with $p set to a phrase equivalent to the phrase iPhrase of the +** current query is executed. Any column filter that applies to +** phrase iPhrase of the current query is included in $p. For each +** row visited, the callback function passed as the fourth argument +** is invoked. The context and API objects passed to the callback +** function may be used to access the properties of each matched row. +** Invoking Api.xUserData() returns a copy of the pointer passed as +** the third argument to pUserData. +** +** If the callback function returns any value other than SQLITE_OK, the +** query is abandoned and the xQueryPhrase function returns immediately. +** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK. +** Otherwise, the error code is propagated upwards. +** +** If the query runs to completion without incident, SQLITE_OK is returned. +** Or, if some error occurs before the query completes or is aborted by +** the callback, an SQLite error code is returned. +** +** +** xSetAuxdata(pFts5, pAux, xDelete) +** +** Save the pointer passed as the second argument as the extension function's +** "auxiliary data". The pointer may then be retrieved by the current or any +** future invocation of the same fts5 extension function made as part of +** the same MATCH query using the xGetAuxdata() API. +** +** Each extension function is allocated a single auxiliary data slot for +** each FTS query (MATCH expression). If the extension function is invoked +** more than once for a single FTS query, then all invocations share a +** single auxiliary data context. +** +** If there is already an auxiliary data pointer when this function is +** invoked, then it is replaced by the new pointer. If an xDelete callback +** was specified along with the original pointer, it is invoked at this +** point. +** +** The xDelete callback, if one is specified, is also invoked on the +** auxiliary data pointer after the FTS5 query has finished. +** +** If an error (e.g. an OOM condition) occurs within this function, +** the auxiliary data is set to NULL and an error code returned. If the +** xDelete parameter was not NULL, it is invoked on the auxiliary data +** pointer before returning. +** +** +** xGetAuxdata(pFts5, bClear) +** +** Returns the current auxiliary data pointer for the fts5 extension +** function. See the xSetAuxdata() method for details. +** +** If the bClear argument is non-zero, then the auxiliary data is cleared +** (set to NULL) before this function returns. In this case the xDelete, +** if any, is not invoked. +** +** +** xRowCount(pFts5, pnRow) +** +** This function is used to retrieve the total number of rows in the table. +** In other words, the same value that would be returned by: +** +** SELECT count(*) FROM ftstable; +** +** xPhraseFirst() +** This function is used, along with type Fts5PhraseIter and the xPhraseNext +** method, to iterate through all instances of a single query phrase within +** the current row. This is the same information as is accessible via the +** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient +** to use, this API may be faster under some circumstances. To iterate +** through instances of phrase iPhrase, use the following code: +** +** Fts5PhraseIter iter; +** int iCol, iOff; +** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff); +** iCol>=0; +** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff) +** ){ +** // An instance of phrase iPhrase at offset iOff of column iCol +** } +** +** The Fts5PhraseIter structure is defined above. Applications should not +** modify this structure directly - it should only be used as shown above +** with the xPhraseFirst() and xPhraseNext() API methods (and by +** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below). +** +** This API can be quite slow if used with an FTS5 table created with the +** "detail=none" or "detail=column" option. If the FTS5 table is created +** with either "detail=none" or "detail=column" and "content=" option +** (i.e. if it is a contentless table), then this API always iterates +** through an empty set (all calls to xPhraseFirst() set iCol to -1). +** +** xPhraseNext() +** See xPhraseFirst above. +** +** xPhraseFirstColumn() +** This function and xPhraseNextColumn() are similar to the xPhraseFirst() +** and xPhraseNext() APIs described above. The difference is that instead +** of iterating through all instances of a phrase in the current row, these +** APIs are used to iterate through the set of columns in the current row +** that contain one or more instances of a specified phrase. For example: +** +** Fts5PhraseIter iter; +** int iCol; +** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol); +** iCol>=0; +** pApi->xPhraseNextColumn(pFts, &iter, &iCol) +** ){ +** // Column iCol contains at least one instance of phrase iPhrase +** } +** +** This API can be quite slow if used with an FTS5 table created with the +** "detail=none" option. If the FTS5 table is created with either +** "detail=none" "content=" option (i.e. if it is a contentless table), +** then this API always iterates through an empty set (all calls to +** xPhraseFirstColumn() set iCol to -1). +** +** The information accessed using this API and its companion +** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext +** (or xInst/xInstCount). The chief advantage of this API is that it is +** significantly more efficient than those alternatives when used with +** "detail=column" tables. +** +** xPhraseNextColumn() +** See xPhraseFirstColumn above. +*/ +struct Fts5ExtensionApi { + int iVersion; /* Currently always set to 3 */ + + void *(*xUserData)(Fts5Context*); + + int (*xColumnCount)(Fts5Context*); + int (*xRowCount)(Fts5Context*, tdsqlite3_int64 *pnRow); + int (*xColumnTotalSize)(Fts5Context*, int iCol, tdsqlite3_int64 *pnToken); + + int (*xTokenize)(Fts5Context*, + const char *pText, int nText, /* Text to tokenize */ + void *pCtx, /* Context passed to xToken() */ + int (*xToken)(void*, int, const char*, int, int, int) /* Callback */ + ); + + int (*xPhraseCount)(Fts5Context*); + int (*xPhraseSize)(Fts5Context*, int iPhrase); + + int (*xInstCount)(Fts5Context*, int *pnInst); + int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff); + + tdsqlite3_int64 (*xRowid)(Fts5Context*); + int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn); + int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken); + + int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData, + int(*)(const Fts5ExtensionApi*,Fts5Context*,void*) + ); + int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*)); + void *(*xGetAuxdata)(Fts5Context*, int bClear); + + int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*); + void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff); + + int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*); + void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol); +}; + +/* +** CUSTOM AUXILIARY FUNCTIONS +*************************************************************************/ + +/************************************************************************* +** CUSTOM TOKENIZERS +** +** Applications may also register custom tokenizer types. A tokenizer +** is registered by providing fts5 with a populated instance of the +** following structure. All structure methods must be defined, setting +** any member of the fts5_tokenizer struct to NULL leads to undefined +** behaviour. The structure methods are expected to function as follows: +** +** xCreate: +** This function is used to allocate and initialize a tokenizer instance. +** A tokenizer instance is required to actually tokenize text. +** +** The first argument passed to this function is a copy of the (void*) +** pointer provided by the application when the fts5_tokenizer object +** was registered with FTS5 (the third argument to xCreateTokenizer()). +** The second and third arguments are an array of nul-terminated strings +** containing the tokenizer arguments, if any, specified following the +** tokenizer name as part of the CREATE VIRTUAL TABLE statement used +** to create the FTS5 table. +** +** The final argument is an output variable. If successful, (*ppOut) +** should be set to point to the new tokenizer handle and SQLITE_OK +** returned. If an error occurs, some value other than SQLITE_OK should +** be returned. In this case, fts5 assumes that the final value of *ppOut +** is undefined. +** +** xDelete: +** This function is invoked to delete a tokenizer handle previously +** allocated using xCreate(). Fts5 guarantees that this function will +** be invoked exactly once for each successful call to xCreate(). +** +** xTokenize: +** This function is expected to tokenize the nText byte string indicated +** by argument pText. pText may or may not be nul-terminated. The first +** argument passed to this function is a pointer to an Fts5Tokenizer object +** returned by an earlier call to xCreate(). +** +** The second argument indicates the reason that FTS5 is requesting +** tokenization of the supplied text. This is always one of the following +** four values: +** +**
  • FTS5_TOKENIZE_DOCUMENT - A document is being inserted into +** or removed from the FTS table. The tokenizer is being invoked to +** determine the set of tokens to add to (or delete from) the +** FTS index. +** +**
  • FTS5_TOKENIZE_QUERY - A MATCH query is being executed +** against the FTS index. The tokenizer is being called to tokenize +** a bareword or quoted string specified as part of the query. +** +**
  • (FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX) - Same as +** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is +** followed by a "*" character, indicating that the last token +** returned by the tokenizer will be treated as a token prefix. +** +**
  • FTS5_TOKENIZE_AUX - The tokenizer is being invoked to +** satisfy an fts5_api.xTokenize() request made by an auxiliary +** function. Or an fts5_api.xColumnSize() request made by the same +** on a columnsize=0 database. +**
+** +** For each token in the input string, the supplied callback xToken() must +** be invoked. The first argument to it should be a copy of the pointer +** passed as the second argument to xTokenize(). The third and fourth +** arguments are a pointer to a buffer containing the token text, and the +** size of the token in bytes. The 4th and 5th arguments are the byte offsets +** of the first byte of and first byte immediately following the text from +** which the token is derived within the input. +** +** The second argument passed to the xToken() callback ("tflags") should +** normally be set to 0. The exception is if the tokenizer supports +** synonyms. In this case see the discussion below for details. +** +** FTS5 assumes the xToken() callback is invoked for each token in the +** order that they occur within the input text. +** +** If an xToken() callback returns any value other than SQLITE_OK, then +** the tokenization should be abandoned and the xTokenize() method should +** immediately return a copy of the xToken() return value. Or, if the +** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally, +** if an error occurs with the xTokenize() implementation itself, it +** may abandon the tokenization and return any error code other than +** SQLITE_OK or SQLITE_DONE. +** +** SYNONYM SUPPORT +** +** Custom tokenizers may also support synonyms. Consider a case in which a +** user wishes to query for a phrase such as "first place". Using the +** built-in tokenizers, the FTS5 query 'first + place' will match instances +** of "first place" within the document set, but not alternative forms +** such as "1st place". In some applications, it would be better to match +** all instances of "first place" or "1st place" regardless of which form +** the user specified in the MATCH query text. +** +** There are several ways to approach this in FTS5: +** +**
  1. By mapping all synonyms to a single token. In this case, using +** the above example, this means that the tokenizer returns the +** same token for inputs "first" and "1st". Say that token is in +** fact "first", so that when the user inserts the document "I won +** 1st place" entries are added to the index for tokens "i", "won", +** "first" and "place". If the user then queries for '1st + place', +** the tokenizer substitutes "first" for "1st" and the query works +** as expected. +** +**
  2. By querying the index for all synonyms of each query term +** separately. In this case, when tokenizing query text, the +** tokenizer may provide multiple synonyms for a single term +** within the document. FTS5 then queries the index for each +** synonym individually. For example, faced with the query: +** +** +** ... MATCH 'first place' +** +** the tokenizer offers both "1st" and "first" as synonyms for the +** first token in the MATCH query and FTS5 effectively runs a query +** similar to: +** +** +** ... MATCH '(first OR 1st) place' +** +** except that, for the purposes of auxiliary functions, the query +** still appears to contain just two phrases - "(first OR 1st)" +** being treated as a single phrase. +** +**
  3. By adding multiple synonyms for a single term to the FTS index. +** Using this method, when tokenizing document text, the tokenizer +** provides multiple synonyms for each token. So that when a +** document such as "I won first place" is tokenized, entries are +** added to the FTS index for "i", "won", "first", "1st" and +** "place". +** +** This way, even if the tokenizer does not provide synonyms +** when tokenizing query text (it should not - to do so would be +** inefficient), it doesn't matter if the user queries for +** 'first + place' or '1st + place', as there are entries in the +** FTS index corresponding to both forms of the first token. +**
+** +** Whether it is parsing document or query text, any call to xToken that +** specifies a tflags argument with the FTS5_TOKEN_COLOCATED bit +** is considered to supply a synonym for the previous token. For example, +** when parsing the document "I won first place", a tokenizer that supports +** synonyms would call xToken() 5 times, as follows: +** +** +** xToken(pCtx, 0, "i", 1, 0, 1); +** xToken(pCtx, 0, "won", 3, 2, 5); +** xToken(pCtx, 0, "first", 5, 6, 11); +** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11); +** xToken(pCtx, 0, "place", 5, 12, 17); +** +** +** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time +** xToken() is called. Multiple synonyms may be specified for a single token +** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence. +** There is no limit to the number of synonyms that may be provided for a +** single token. +** +** In many cases, method (1) above is the best approach. It does not add +** extra data to the FTS index or require FTS5 to query for multiple terms, +** so it is efficient in terms of disk space and query speed. However, it +** does not support prefix queries very well. If, as suggested above, the +** token "first" is substituted for "1st" by the tokenizer, then the query: +** +** +** ... MATCH '1s*' +** +** will not match documents that contain the token "1st" (as the tokenizer +** will probably not map "1s" to any prefix of "first"). +** +** For full prefix support, method (3) may be preferred. In this case, +** because the index contains entries for both "first" and "1st", prefix +** queries such as 'fi*' or '1s*' will match correctly. However, because +** extra entries are added to the FTS index, this method uses more space +** within the database. +** +** Method (2) offers a midpoint between (1) and (3). Using this method, +** a query such as '1s*' will match documents that contain the literal +** token "1st", but not "first" (assuming the tokenizer is not able to +** provide synonyms for prefixes). However, a non-prefix query like '1st' +** will match against "1st" and "first". This method does not require +** extra disk space, as no extra entries are added to the FTS index. +** On the other hand, it may require more CPU cycles to run MATCH queries, +** as separate queries of the FTS index are required for each synonym. +** +** When using methods (2) or (3), it is important that the tokenizer only +** provide synonyms when tokenizing document text (method (2)) or query +** text (method (3)), not both. Doing so will not cause any errors, but is +** inefficient. +*/ +typedef struct Fts5Tokenizer Fts5Tokenizer; +typedef struct fts5_tokenizer fts5_tokenizer; +struct fts5_tokenizer { + int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut); + void (*xDelete)(Fts5Tokenizer*); + int (*xTokenize)(Fts5Tokenizer*, + void *pCtx, + int flags, /* Mask of FTS5_TOKENIZE_* flags */ + const char *pText, int nText, + int (*xToken)( + void *pCtx, /* Copy of 2nd argument to xTokenize() */ + int tflags, /* Mask of FTS5_TOKEN_* flags */ + const char *pToken, /* Pointer to buffer containing token */ + int nToken, /* Size of token in bytes */ + int iStart, /* Byte offset of token within input text */ + int iEnd /* Byte offset of end of token within input text */ + ) + ); +}; + +/* Flags that may be passed as the third argument to xTokenize() */ +#define FTS5_TOKENIZE_QUERY 0x0001 +#define FTS5_TOKENIZE_PREFIX 0x0002 +#define FTS5_TOKENIZE_DOCUMENT 0x0004 +#define FTS5_TOKENIZE_AUX 0x0008 + +/* Flags that may be passed by the tokenizer implementation back to FTS5 +** as the third argument to the supplied xToken callback. */ +#define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */ + +/* +** END OF CUSTOM TOKENIZERS +*************************************************************************/ + +/************************************************************************* +** FTS5 EXTENSION REGISTRATION API +*/ +typedef struct fts5_api fts5_api; +struct fts5_api { + int iVersion; /* Currently always set to 2 */ + + /* Create a new tokenizer */ + int (*xCreateTokenizer)( + fts5_api *pApi, + const char *zName, + void *pContext, + fts5_tokenizer *pTokenizer, + void (*xDestroy)(void*) + ); + + /* Find an existing tokenizer */ + int (*xFindTokenizer)( + fts5_api *pApi, + const char *zName, + void **ppContext, + fts5_tokenizer *pTokenizer + ); + + /* Create a new auxiliary function */ + int (*xCreateFunction)( + fts5_api *pApi, + const char *zName, + void *pContext, + fts5_extension_function xFunction, + void (*xDestroy)(void*) + ); +}; + +/* +** END OF REGISTRATION API +*************************************************************************/ + +#ifdef __cplusplus +} /* end of the 'extern "C"' block */ +#endif + +#endif /* _FTS5_H */ + +/******** End of fts5.h *********/ diff --git a/third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3ext.h b/third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3ext.h new file mode 100644 index 0000000000..1b5d136d58 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3ext.h @@ -0,0 +1,650 @@ +/* +** 2006 June 7 +** +** The author disclaims copyright to this source code. In place of +** a legal notice, here is a blessing: +** +** May you do good and not evil. +** May you find forgiveness for yourself and forgive others. +** May you share freely, never taking more than you give. +** +************************************************************************* +** This header file defines the SQLite interface for use by +** shared libraries that want to be imported as extensions into +** an SQLite instance. Shared libraries that intend to be loaded +** as extensions by SQLite should #include this file instead of +** sqlite3.h. +*/ +#ifndef SQLITE3EXT_H +#define SQLITE3EXT_H +#include "sqlite3.h" + +/* +** The following structure holds pointers to all of the SQLite API +** routines. +** +** WARNING: In order to maintain backwards compatibility, add new +** interfaces to the end of this structure only. If you insert new +** interfaces in the middle of this structure, then older different +** versions of SQLite will not be able to load each other's shared +** libraries! +*/ +struct tdsqlite3_api_routines { + void * (*aggregate_context)(tdsqlite3_context*,int nBytes); + int (*aggregate_count)(tdsqlite3_context*); + int (*bind_blob)(tdsqlite3_stmt*,int,const void*,int n,void(*)(void*)); + int (*bind_double)(tdsqlite3_stmt*,int,double); + int (*bind_int)(tdsqlite3_stmt*,int,int); + int (*bind_int64)(tdsqlite3_stmt*,int,sqlite_int64); + int (*bind_null)(tdsqlite3_stmt*,int); + int (*bind_parameter_count)(tdsqlite3_stmt*); + int (*bind_parameter_index)(tdsqlite3_stmt*,const char*zName); + const char * (*bind_parameter_name)(tdsqlite3_stmt*,int); + int (*bind_text)(tdsqlite3_stmt*,int,const char*,int n,void(*)(void*)); + int (*bind_text16)(tdsqlite3_stmt*,int,const void*,int,void(*)(void*)); + int (*bind_value)(tdsqlite3_stmt*,int,const tdsqlite3_value*); + int (*busy_handler)(tdsqlite3*,int(*)(void*,int),void*); + int (*busy_timeout)(tdsqlite3*,int ms); + int (*changes)(tdsqlite3*); + int (*close)(tdsqlite3*); + int (*collation_needed)(tdsqlite3*,void*,void(*)(void*,tdsqlite3*, + int eTextRep,const char*)); + int (*collation_needed16)(tdsqlite3*,void*,void(*)(void*,tdsqlite3*, + int eTextRep,const void*)); + const void * (*column_blob)(tdsqlite3_stmt*,int iCol); + int (*column_bytes)(tdsqlite3_stmt*,int iCol); + int (*column_bytes16)(tdsqlite3_stmt*,int iCol); + int (*column_count)(tdsqlite3_stmt*pStmt); + const char * (*column_database_name)(tdsqlite3_stmt*,int); + const void * (*column_database_name16)(tdsqlite3_stmt*,int); + const char * (*column_decltype)(tdsqlite3_stmt*,int i); + const void * (*column_decltype16)(tdsqlite3_stmt*,int); + double (*column_double)(tdsqlite3_stmt*,int iCol); + int (*column_int)(tdsqlite3_stmt*,int iCol); + sqlite_int64 (*column_int64)(tdsqlite3_stmt*,int iCol); + const char * (*column_name)(tdsqlite3_stmt*,int); + const void * (*column_name16)(tdsqlite3_stmt*,int); + const char * (*column_origin_name)(tdsqlite3_stmt*,int); + const void * (*column_origin_name16)(tdsqlite3_stmt*,int); + const char * (*column_table_name)(tdsqlite3_stmt*,int); + const void * (*column_table_name16)(tdsqlite3_stmt*,int); + const unsigned char * (*column_text)(tdsqlite3_stmt*,int iCol); + const void * (*column_text16)(tdsqlite3_stmt*,int iCol); + int (*column_type)(tdsqlite3_stmt*,int iCol); + tdsqlite3_value* (*column_value)(tdsqlite3_stmt*,int iCol); + void * (*commit_hook)(tdsqlite3*,int(*)(void*),void*); + int (*complete)(const char*sql); + int (*complete16)(const void*sql); + int (*create_collation)(tdsqlite3*,const char*,int,void*, + int(*)(void*,int,const void*,int,const void*)); + int (*create_collation16)(tdsqlite3*,const void*,int,void*, + int(*)(void*,int,const void*,int,const void*)); + int (*create_function)(tdsqlite3*,const char*,int,int,void*, + void (*xFunc)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xStep)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xFinal)(tdsqlite3_context*)); + int (*create_function16)(tdsqlite3*,const void*,int,int,void*, + void (*xFunc)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xStep)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xFinal)(tdsqlite3_context*)); + int (*create_module)(tdsqlite3*,const char*,const tdsqlite3_module*,void*); + int (*data_count)(tdsqlite3_stmt*pStmt); + tdsqlite3 * (*db_handle)(tdsqlite3_stmt*); + int (*declare_vtab)(tdsqlite3*,const char*); + int (*enable_shared_cache)(int); + int (*errcode)(tdsqlite3*db); + const char * (*errmsg)(tdsqlite3*); + const void * (*errmsg16)(tdsqlite3*); + int (*exec)(tdsqlite3*,const char*,tdsqlite3_callback,void*,char**); + int (*expired)(tdsqlite3_stmt*); + int (*finalize)(tdsqlite3_stmt*pStmt); + void (*free)(void*); + void (*free_table)(char**result); + int (*get_autocommit)(tdsqlite3*); + void * (*get_auxdata)(tdsqlite3_context*,int); + int (*get_table)(tdsqlite3*,const char*,char***,int*,int*,char**); + int (*global_recover)(void); + void (*interruptx)(tdsqlite3*); + sqlite_int64 (*last_insert_rowid)(tdsqlite3*); + const char * (*libversion)(void); + int (*libversion_number)(void); + void *(*malloc)(int); + char * (*mprintf)(const char*,...); + int (*open)(const char*,tdsqlite3**); + int (*open16)(const void*,tdsqlite3**); + int (*prepare)(tdsqlite3*,const char*,int,tdsqlite3_stmt**,const char**); + int (*prepare16)(tdsqlite3*,const void*,int,tdsqlite3_stmt**,const void**); + void * (*profile)(tdsqlite3*,void(*)(void*,const char*,sqlite_uint64),void*); + void (*progress_handler)(tdsqlite3*,int,int(*)(void*),void*); + void *(*realloc)(void*,int); + int (*reset)(tdsqlite3_stmt*pStmt); + void (*result_blob)(tdsqlite3_context*,const void*,int,void(*)(void*)); + void (*result_double)(tdsqlite3_context*,double); + void (*result_error)(tdsqlite3_context*,const char*,int); + void (*result_error16)(tdsqlite3_context*,const void*,int); + void (*result_int)(tdsqlite3_context*,int); + void (*result_int64)(tdsqlite3_context*,sqlite_int64); + void (*result_null)(tdsqlite3_context*); + void (*result_text)(tdsqlite3_context*,const char*,int,void(*)(void*)); + void (*result_text16)(tdsqlite3_context*,const void*,int,void(*)(void*)); + void (*result_text16be)(tdsqlite3_context*,const void*,int,void(*)(void*)); + void (*result_text16le)(tdsqlite3_context*,const void*,int,void(*)(void*)); + void (*result_value)(tdsqlite3_context*,tdsqlite3_value*); + void * (*rollback_hook)(tdsqlite3*,void(*)(void*),void*); + int (*set_authorizer)(tdsqlite3*,int(*)(void*,int,const char*,const char*, + const char*,const char*),void*); + void (*set_auxdata)(tdsqlite3_context*,int,void*,void (*)(void*)); + char * (*xsnprintf)(int,char*,const char*,...); + int (*step)(tdsqlite3_stmt*); + int (*table_column_metadata)(tdsqlite3*,const char*,const char*,const char*, + char const**,char const**,int*,int*,int*); + void (*thread_cleanup)(void); + int (*total_changes)(tdsqlite3*); + void * (*trace)(tdsqlite3*,void(*xTrace)(void*,const char*),void*); + int (*transfer_bindings)(tdsqlite3_stmt*,tdsqlite3_stmt*); + void * (*update_hook)(tdsqlite3*,void(*)(void*,int ,char const*,char const*, + sqlite_int64),void*); + void * (*user_data)(tdsqlite3_context*); + const void * (*value_blob)(tdsqlite3_value*); + int (*value_bytes)(tdsqlite3_value*); + int (*value_bytes16)(tdsqlite3_value*); + double (*value_double)(tdsqlite3_value*); + int (*value_int)(tdsqlite3_value*); + sqlite_int64 (*value_int64)(tdsqlite3_value*); + int (*value_numeric_type)(tdsqlite3_value*); + const unsigned char * (*value_text)(tdsqlite3_value*); + const void * (*value_text16)(tdsqlite3_value*); + const void * (*value_text16be)(tdsqlite3_value*); + const void * (*value_text16le)(tdsqlite3_value*); + int (*value_type)(tdsqlite3_value*); + char *(*vmprintf)(const char*,va_list); + /* Added ??? */ + int (*overload_function)(tdsqlite3*, const char *zFuncName, int nArg); + /* Added by 3.3.13 */ + int (*prepare_v2)(tdsqlite3*,const char*,int,tdsqlite3_stmt**,const char**); + int (*prepare16_v2)(tdsqlite3*,const void*,int,tdsqlite3_stmt**,const void**); + int (*clear_bindings)(tdsqlite3_stmt*); + /* Added by 3.4.1 */ + int (*create_module_v2)(tdsqlite3*,const char*,const tdsqlite3_module*,void*, + void (*xDestroy)(void *)); + /* Added by 3.5.0 */ + int (*bind_zeroblob)(tdsqlite3_stmt*,int,int); + int (*blob_bytes)(tdsqlite3_blob*); + int (*blob_close)(tdsqlite3_blob*); + int (*blob_open)(tdsqlite3*,const char*,const char*,const char*,tdsqlite3_int64, + int,tdsqlite3_blob**); + int (*blob_read)(tdsqlite3_blob*,void*,int,int); + int (*blob_write)(tdsqlite3_blob*,const void*,int,int); + int (*create_collation_v2)(tdsqlite3*,const char*,int,void*, + int(*)(void*,int,const void*,int,const void*), + void(*)(void*)); + int (*file_control)(tdsqlite3*,const char*,int,void*); + tdsqlite3_int64 (*memory_highwater)(int); + tdsqlite3_int64 (*memory_used)(void); + tdsqlite3_mutex *(*mutex_alloc)(int); + void (*mutex_enter)(tdsqlite3_mutex*); + void (*mutex_free)(tdsqlite3_mutex*); + void (*mutex_leave)(tdsqlite3_mutex*); + int (*mutex_try)(tdsqlite3_mutex*); + int (*open_v2)(const char*,tdsqlite3**,int,const char*); + int (*release_memory)(int); + void (*result_error_nomem)(tdsqlite3_context*); + void (*result_error_toobig)(tdsqlite3_context*); + int (*sleep)(int); + void (*soft_heap_limit)(int); + tdsqlite3_vfs *(*vfs_find)(const char*); + int (*vfs_register)(tdsqlite3_vfs*,int); + int (*vfs_unregister)(tdsqlite3_vfs*); + int (*xthreadsafe)(void); + void (*result_zeroblob)(tdsqlite3_context*,int); + void (*result_error_code)(tdsqlite3_context*,int); + int (*test_control)(int, ...); + void (*randomness)(int,void*); + tdsqlite3 *(*context_db_handle)(tdsqlite3_context*); + int (*extended_result_codes)(tdsqlite3*,int); + int (*limit)(tdsqlite3*,int,int); + tdsqlite3_stmt *(*next_stmt)(tdsqlite3*,tdsqlite3_stmt*); + const char *(*sql)(tdsqlite3_stmt*); + int (*status)(int,int*,int*,int); + int (*backup_finish)(tdsqlite3_backup*); + tdsqlite3_backup *(*backup_init)(tdsqlite3*,const char*,tdsqlite3*,const char*); + int (*backup_pagecount)(tdsqlite3_backup*); + int (*backup_remaining)(tdsqlite3_backup*); + int (*backup_step)(tdsqlite3_backup*,int); + const char *(*compileoption_get)(int); + int (*compileoption_used)(const char*); + int (*create_function_v2)(tdsqlite3*,const char*,int,int,void*, + void (*xFunc)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xStep)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xFinal)(tdsqlite3_context*), + void(*xDestroy)(void*)); + int (*db_config)(tdsqlite3*,int,...); + tdsqlite3_mutex *(*db_mutex)(tdsqlite3*); + int (*db_status)(tdsqlite3*,int,int*,int*,int); + int (*extended_errcode)(tdsqlite3*); + void (*log)(int,const char*,...); + tdsqlite3_int64 (*soft_heap_limit64)(tdsqlite3_int64); + const char *(*sourceid)(void); + int (*stmt_status)(tdsqlite3_stmt*,int,int); + int (*strnicmp)(const char*,const char*,int); + int (*unlock_notify)(tdsqlite3*,void(*)(void**,int),void*); + int (*wal_autocheckpoint)(tdsqlite3*,int); + int (*wal_checkpoint)(tdsqlite3*,const char*); + void *(*wal_hook)(tdsqlite3*,int(*)(void*,tdsqlite3*,const char*,int),void*); + int (*blob_reopen)(tdsqlite3_blob*,tdsqlite3_int64); + int (*vtab_config)(tdsqlite3*,int op,...); + int (*vtab_on_conflict)(tdsqlite3*); + /* Version 3.7.16 and later */ + int (*close_v2)(tdsqlite3*); + const char *(*db_filename)(tdsqlite3*,const char*); + int (*db_readonly)(tdsqlite3*,const char*); + int (*db_release_memory)(tdsqlite3*); + const char *(*errstr)(int); + int (*stmt_busy)(tdsqlite3_stmt*); + int (*stmt_readonly)(tdsqlite3_stmt*); + int (*stricmp)(const char*,const char*); + int (*uri_boolean)(const char*,const char*,int); + tdsqlite3_int64 (*uri_int64)(const char*,const char*,tdsqlite3_int64); + const char *(*uri_parameter)(const char*,const char*); + char *(*xvsnprintf)(int,char*,const char*,va_list); + int (*wal_checkpoint_v2)(tdsqlite3*,const char*,int,int*,int*); + /* Version 3.8.7 and later */ + int (*auto_extension)(void(*)(void)); + int (*bind_blob64)(tdsqlite3_stmt*,int,const void*,tdsqlite3_uint64, + void(*)(void*)); + int (*bind_text64)(tdsqlite3_stmt*,int,const char*,tdsqlite3_uint64, + void(*)(void*),unsigned char); + int (*cancel_auto_extension)(void(*)(void)); + int (*load_extension)(tdsqlite3*,const char*,const char*,char**); + void *(*malloc64)(tdsqlite3_uint64); + tdsqlite3_uint64 (*msize)(void*); + void *(*realloc64)(void*,tdsqlite3_uint64); + void (*reset_auto_extension)(void); + void (*result_blob64)(tdsqlite3_context*,const void*,tdsqlite3_uint64, + void(*)(void*)); + void (*result_text64)(tdsqlite3_context*,const char*,tdsqlite3_uint64, + void(*)(void*), unsigned char); + int (*strglob)(const char*,const char*); + /* Version 3.8.11 and later */ + tdsqlite3_value *(*value_dup)(const tdsqlite3_value*); + void (*value_free)(tdsqlite3_value*); + int (*result_zeroblob64)(tdsqlite3_context*,tdsqlite3_uint64); + int (*bind_zeroblob64)(tdsqlite3_stmt*, int, tdsqlite3_uint64); + /* Version 3.9.0 and later */ + unsigned int (*value_subtype)(tdsqlite3_value*); + void (*result_subtype)(tdsqlite3_context*,unsigned int); + /* Version 3.10.0 and later */ + int (*status64)(int,tdsqlite3_int64*,tdsqlite3_int64*,int); + int (*strlike)(const char*,const char*,unsigned int); + int (*db_cacheflush)(tdsqlite3*); + /* Version 3.12.0 and later */ + int (*system_errno)(tdsqlite3*); + /* Version 3.14.0 and later */ + int (*trace_v2)(tdsqlite3*,unsigned,int(*)(unsigned,void*,void*,void*),void*); + char *(*expanded_sql)(tdsqlite3_stmt*); + /* Version 3.18.0 and later */ + void (*set_last_insert_rowid)(tdsqlite3*,tdsqlite3_int64); + /* Version 3.20.0 and later */ + int (*prepare_v3)(tdsqlite3*,const char*,int,unsigned int, + tdsqlite3_stmt**,const char**); + int (*prepare16_v3)(tdsqlite3*,const void*,int,unsigned int, + tdsqlite3_stmt**,const void**); + int (*bind_pointer)(tdsqlite3_stmt*,int,void*,const char*,void(*)(void*)); + void (*result_pointer)(tdsqlite3_context*,void*,const char*,void(*)(void*)); + void *(*value_pointer)(tdsqlite3_value*,const char*); + int (*vtab_nochange)(tdsqlite3_context*); + int (*value_nochange)(tdsqlite3_value*); + const char *(*vtab_collation)(tdsqlite3_index_info*,int); + /* Version 3.24.0 and later */ + int (*keyword_count)(void); + int (*keyword_name)(int,const char**,int*); + int (*keyword_check)(const char*,int); + tdsqlite3_str *(*str_new)(tdsqlite3*); + char *(*str_finish)(tdsqlite3_str*); + void (*str_appendf)(tdsqlite3_str*, const char *zFormat, ...); + void (*str_vappendf)(tdsqlite3_str*, const char *zFormat, va_list); + void (*str_append)(tdsqlite3_str*, const char *zIn, int N); + void (*str_appendall)(tdsqlite3_str*, const char *zIn); + void (*str_appendchar)(tdsqlite3_str*, int N, char C); + void (*str_reset)(tdsqlite3_str*); + int (*str_errcode)(tdsqlite3_str*); + int (*str_length)(tdsqlite3_str*); + char *(*str_value)(tdsqlite3_str*); + /* Version 3.25.0 and later */ + int (*create_window_function)(tdsqlite3*,const char*,int,int,void*, + void (*xStep)(tdsqlite3_context*,int,tdsqlite3_value**), + void (*xFinal)(tdsqlite3_context*), + void (*xValue)(tdsqlite3_context*), + void (*xInv)(tdsqlite3_context*,int,tdsqlite3_value**), + void(*xDestroy)(void*)); + /* Version 3.26.0 and later */ + const char *(*normalized_sql)(tdsqlite3_stmt*); + /* Version 3.28.0 and later */ + int (*stmt_isexplain)(tdsqlite3_stmt*); + int (*value_frombind)(tdsqlite3_value*); + /* Version 3.30.0 and later */ + int (*drop_modules)(tdsqlite3*,const char**); + /* Version 3.31.0 and later */ + tdsqlite3_int64 (*hard_heap_limit64)(tdsqlite3_int64); + const char *(*uri_key)(const char*,int); + const char *(*filename_database)(const char*); + const char *(*filename_journal)(const char*); + const char *(*filename_wal)(const char*); +}; + +/* +** This is the function signature used for all extension entry points. It +** is also defined in the file "loadext.c". +*/ +typedef int (*tdsqlite3_loadext_entry)( + tdsqlite3 *db, /* Handle to the database. */ + char **pzErrMsg, /* Used to set error string on failure. */ + const tdsqlite3_api_routines *pThunk /* Extension API function pointers. */ +); + +/* +** The following macros redefine the API routines so that they are +** redirected through the global tdsqlite3_api structure. +** +** This header file is also used by the loadext.c source file +** (part of the main SQLite library - not an extension) so that +** it can get access to the tdsqlite3_api_routines structure +** definition. But the main library does not want to redefine +** the API. So the redefinition macros are only valid if the +** SQLITE_CORE macros is undefined. +*/ +#if !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION) +#define tdsqlite3_aggregate_context tdsqlite3_api->aggregate_context +#ifndef SQLITE_OMIT_DEPRECATED +#define tdsqlite3_aggregate_count tdsqlite3_api->aggregate_count +#endif +#define tdsqlite3_bind_blob tdsqlite3_api->bind_blob +#define tdsqlite3_bind_double tdsqlite3_api->bind_double +#define tdsqlite3_bind_int tdsqlite3_api->bind_int +#define tdsqlite3_bind_int64 tdsqlite3_api->bind_int64 +#define tdsqlite3_bind_null tdsqlite3_api->bind_null +#define tdsqlite3_bind_parameter_count tdsqlite3_api->bind_parameter_count +#define tdsqlite3_bind_parameter_index tdsqlite3_api->bind_parameter_index +#define tdsqlite3_bind_parameter_name tdsqlite3_api->bind_parameter_name +#define tdsqlite3_bind_text tdsqlite3_api->bind_text +#define tdsqlite3_bind_text16 tdsqlite3_api->bind_text16 +#define tdsqlite3_bind_value tdsqlite3_api->bind_value +#define tdsqlite3_busy_handler tdsqlite3_api->busy_handler +#define tdsqlite3_busy_timeout tdsqlite3_api->busy_timeout +#define tdsqlite3_changes tdsqlite3_api->changes +#define tdsqlite3_close tdsqlite3_api->close +#define tdsqlite3_collation_needed tdsqlite3_api->collation_needed +#define tdsqlite3_collation_needed16 tdsqlite3_api->collation_needed16 +#define tdsqlite3_column_blob tdsqlite3_api->column_blob +#define tdsqlite3_column_bytes tdsqlite3_api->column_bytes +#define tdsqlite3_column_bytes16 tdsqlite3_api->column_bytes16 +#define tdsqlite3_column_count tdsqlite3_api->column_count +#define tdsqlite3_column_database_name tdsqlite3_api->column_database_name +#define tdsqlite3_column_database_name16 tdsqlite3_api->column_database_name16 +#define tdsqlite3_column_decltype tdsqlite3_api->column_decltype +#define tdsqlite3_column_decltype16 tdsqlite3_api->column_decltype16 +#define tdsqlite3_column_double tdsqlite3_api->column_double +#define tdsqlite3_column_int tdsqlite3_api->column_int +#define tdsqlite3_column_int64 tdsqlite3_api->column_int64 +#define tdsqlite3_column_name tdsqlite3_api->column_name +#define tdsqlite3_column_name16 tdsqlite3_api->column_name16 +#define tdsqlite3_column_origin_name tdsqlite3_api->column_origin_name +#define tdsqlite3_column_origin_name16 tdsqlite3_api->column_origin_name16 +#define tdsqlite3_column_table_name tdsqlite3_api->column_table_name +#define tdsqlite3_column_table_name16 tdsqlite3_api->column_table_name16 +#define tdsqlite3_column_text tdsqlite3_api->column_text +#define tdsqlite3_column_text16 tdsqlite3_api->column_text16 +#define tdsqlite3_column_type tdsqlite3_api->column_type +#define tdsqlite3_column_value tdsqlite3_api->column_value +#define tdsqlite3_commit_hook tdsqlite3_api->commit_hook +#define tdsqlite3_complete tdsqlite3_api->complete +#define tdsqlite3_complete16 tdsqlite3_api->complete16 +#define tdsqlite3_create_collation tdsqlite3_api->create_collation +#define tdsqlite3_create_collation16 tdsqlite3_api->create_collation16 +#define tdsqlite3_create_function tdsqlite3_api->create_function +#define tdsqlite3_create_function16 tdsqlite3_api->create_function16 +#define tdsqlite3_create_module tdsqlite3_api->create_module +#define tdsqlite3_create_module_v2 tdsqlite3_api->create_module_v2 +#define tdsqlite3_data_count tdsqlite3_api->data_count +#define tdsqlite3_db_handle tdsqlite3_api->db_handle +#define tdsqlite3_declare_vtab tdsqlite3_api->declare_vtab +#define tdsqlite3_enable_shared_cache tdsqlite3_api->enable_shared_cache +#define tdsqlite3_errcode tdsqlite3_api->errcode +#define tdsqlite3_errmsg tdsqlite3_api->errmsg +#define tdsqlite3_errmsg16 tdsqlite3_api->errmsg16 +#define tdsqlite3_exec tdsqlite3_api->exec +#ifndef SQLITE_OMIT_DEPRECATED +#define tdsqlite3_expired tdsqlite3_api->expired +#endif +#define tdsqlite3_finalize tdsqlite3_api->finalize +#define tdsqlite3_free tdsqlite3_api->free +#define tdsqlite3_free_table tdsqlite3_api->free_table +#define tdsqlite3_get_autocommit tdsqlite3_api->get_autocommit +#define tdsqlite3_get_auxdata tdsqlite3_api->get_auxdata +#define tdsqlite3_get_table tdsqlite3_api->get_table +#ifndef SQLITE_OMIT_DEPRECATED +#define tdsqlite3_global_recover tdsqlite3_api->global_recover +#endif +#define tdsqlite3_interrupt tdsqlite3_api->interruptx +#define tdsqlite3_last_insert_rowid tdsqlite3_api->last_insert_rowid +#define tdsqlite3_libversion tdsqlite3_api->libversion +#define tdsqlite3_libversion_number tdsqlite3_api->libversion_number +#define tdsqlite3_malloc tdsqlite3_api->malloc +#define tdsqlite3_mprintf tdsqlite3_api->mprintf +#define tdsqlite3_open tdsqlite3_api->open +#define tdsqlite3_open16 tdsqlite3_api->open16 +#define tdsqlite3_prepare tdsqlite3_api->prepare +#define tdsqlite3_prepare16 tdsqlite3_api->prepare16 +#define tdsqlite3_prepare_v2 tdsqlite3_api->prepare_v2 +#define tdsqlite3_prepare16_v2 tdsqlite3_api->prepare16_v2 +#define tdsqlite3_profile tdsqlite3_api->profile +#define tdsqlite3_progress_handler tdsqlite3_api->progress_handler +#define tdsqlite3_realloc tdsqlite3_api->realloc +#define tdsqlite3_reset tdsqlite3_api->reset +#define tdsqlite3_result_blob tdsqlite3_api->result_blob +#define tdsqlite3_result_double tdsqlite3_api->result_double +#define tdsqlite3_result_error tdsqlite3_api->result_error +#define tdsqlite3_result_error16 tdsqlite3_api->result_error16 +#define tdsqlite3_result_int tdsqlite3_api->result_int +#define tdsqlite3_result_int64 tdsqlite3_api->result_int64 +#define tdsqlite3_result_null tdsqlite3_api->result_null +#define tdsqlite3_result_text tdsqlite3_api->result_text +#define tdsqlite3_result_text16 tdsqlite3_api->result_text16 +#define tdsqlite3_result_text16be tdsqlite3_api->result_text16be +#define tdsqlite3_result_text16le tdsqlite3_api->result_text16le +#define tdsqlite3_result_value tdsqlite3_api->result_value +#define tdsqlite3_rollback_hook tdsqlite3_api->rollback_hook +#define tdsqlite3_set_authorizer tdsqlite3_api->set_authorizer +#define tdsqlite3_set_auxdata tdsqlite3_api->set_auxdata +#define tdsqlite3_snprintf tdsqlite3_api->xsnprintf +#define tdsqlite3_step tdsqlite3_api->step +#define tdsqlite3_table_column_metadata tdsqlite3_api->table_column_metadata +#define tdsqlite3_thread_cleanup tdsqlite3_api->thread_cleanup +#define tdsqlite3_total_changes tdsqlite3_api->total_changes +#define tdsqlite3_trace tdsqlite3_api->trace +#ifndef SQLITE_OMIT_DEPRECATED +#define tdsqlite3_transfer_bindings tdsqlite3_api->transfer_bindings +#endif +#define tdsqlite3_update_hook tdsqlite3_api->update_hook +#define tdsqlite3_user_data tdsqlite3_api->user_data +#define tdsqlite3_value_blob tdsqlite3_api->value_blob +#define tdsqlite3_value_bytes tdsqlite3_api->value_bytes +#define tdsqlite3_value_bytes16 tdsqlite3_api->value_bytes16 +#define tdsqlite3_value_double tdsqlite3_api->value_double +#define tdsqlite3_value_int tdsqlite3_api->value_int +#define tdsqlite3_value_int64 tdsqlite3_api->value_int64 +#define tdsqlite3_value_numeric_type tdsqlite3_api->value_numeric_type +#define tdsqlite3_value_text tdsqlite3_api->value_text +#define tdsqlite3_value_text16 tdsqlite3_api->value_text16 +#define tdsqlite3_value_text16be tdsqlite3_api->value_text16be +#define tdsqlite3_value_text16le tdsqlite3_api->value_text16le +#define tdsqlite3_value_type tdsqlite3_api->value_type +#define tdsqlite3_vmprintf tdsqlite3_api->vmprintf +#define tdsqlite3_vsnprintf tdsqlite3_api->xvsnprintf +#define tdsqlite3_overload_function tdsqlite3_api->overload_function +#define tdsqlite3_prepare_v2 tdsqlite3_api->prepare_v2 +#define tdsqlite3_prepare16_v2 tdsqlite3_api->prepare16_v2 +#define tdsqlite3_clear_bindings tdsqlite3_api->clear_bindings +#define tdsqlite3_bind_zeroblob tdsqlite3_api->bind_zeroblob +#define tdsqlite3_blob_bytes tdsqlite3_api->blob_bytes +#define tdsqlite3_blob_close tdsqlite3_api->blob_close +#define tdsqlite3_blob_open tdsqlite3_api->blob_open +#define tdsqlite3_blob_read tdsqlite3_api->blob_read +#define tdsqlite3_blob_write tdsqlite3_api->blob_write +#define tdsqlite3_create_collation_v2 tdsqlite3_api->create_collation_v2 +#define tdsqlite3_file_control tdsqlite3_api->file_control +#define tdsqlite3_memory_highwater tdsqlite3_api->memory_highwater +#define tdsqlite3_memory_used tdsqlite3_api->memory_used +#define tdsqlite3_mutex_alloc tdsqlite3_api->mutex_alloc +#define tdsqlite3_mutex_enter tdsqlite3_api->mutex_enter +#define tdsqlite3_mutex_free tdsqlite3_api->mutex_free +#define tdsqlite3_mutex_leave tdsqlite3_api->mutex_leave +#define tdsqlite3_mutex_try tdsqlite3_api->mutex_try +#define tdsqlite3_open_v2 tdsqlite3_api->open_v2 +#define tdsqlite3_release_memory tdsqlite3_api->release_memory +#define tdsqlite3_result_error_nomem tdsqlite3_api->result_error_nomem +#define tdsqlite3_result_error_toobig tdsqlite3_api->result_error_toobig +#define tdsqlite3_sleep tdsqlite3_api->sleep +#define tdsqlite3_soft_heap_limit tdsqlite3_api->soft_heap_limit +#define tdsqlite3_vfs_find tdsqlite3_api->vfs_find +#define tdsqlite3_vfs_register tdsqlite3_api->vfs_register +#define tdsqlite3_vfs_unregister tdsqlite3_api->vfs_unregister +#define tdsqlite3_threadsafe tdsqlite3_api->xthreadsafe +#define tdsqlite3_result_zeroblob tdsqlite3_api->result_zeroblob +#define tdsqlite3_result_error_code tdsqlite3_api->result_error_code +#define tdsqlite3_test_control tdsqlite3_api->test_control +#define tdsqlite3_randomness tdsqlite3_api->randomness +#define tdsqlite3_context_db_handle tdsqlite3_api->context_db_handle +#define tdsqlite3_extended_result_codes tdsqlite3_api->extended_result_codes +#define tdsqlite3_limit tdsqlite3_api->limit +#define tdsqlite3_next_stmt tdsqlite3_api->next_stmt +#define tdsqlite3_sql tdsqlite3_api->sql +#define tdsqlite3_status tdsqlite3_api->status +#define tdsqlite3_backup_finish tdsqlite3_api->backup_finish +#define tdsqlite3_backup_init tdsqlite3_api->backup_init +#define tdsqlite3_backup_pagecount tdsqlite3_api->backup_pagecount +#define tdsqlite3_backup_remaining tdsqlite3_api->backup_remaining +#define tdsqlite3_backup_step tdsqlite3_api->backup_step +#define tdsqlite3_compileoption_get tdsqlite3_api->compileoption_get +#define tdsqlite3_compileoption_used tdsqlite3_api->compileoption_used +#define tdsqlite3_create_function_v2 tdsqlite3_api->create_function_v2 +#define tdsqlite3_db_config tdsqlite3_api->db_config +#define tdsqlite3_db_mutex tdsqlite3_api->db_mutex +#define tdsqlite3_db_status tdsqlite3_api->db_status +#define tdsqlite3_extended_errcode tdsqlite3_api->extended_errcode +#define tdsqlite3_log tdsqlite3_api->log +#define tdsqlite3_soft_heap_limit64 tdsqlite3_api->soft_heap_limit64 +#define tdsqlite3_sourceid tdsqlite3_api->sourceid +#define tdsqlite3_stmt_status tdsqlite3_api->stmt_status +#define tdsqlite3_strnicmp tdsqlite3_api->strnicmp +#define tdsqlite3_unlock_notify tdsqlite3_api->unlock_notify +#define tdsqlite3_wal_autocheckpoint tdsqlite3_api->wal_autocheckpoint +#define tdsqlite3_wal_checkpoint tdsqlite3_api->wal_checkpoint +#define tdsqlite3_wal_hook tdsqlite3_api->wal_hook +#define tdsqlite3_blob_reopen tdsqlite3_api->blob_reopen +#define tdsqlite3_vtab_config tdsqlite3_api->vtab_config +#define tdsqlite3_vtab_on_conflict tdsqlite3_api->vtab_on_conflict +/* Version 3.7.16 and later */ +#define tdsqlite3_close_v2 tdsqlite3_api->close_v2 +#define tdsqlite3_db_filename tdsqlite3_api->db_filename +#define tdsqlite3_db_readonly tdsqlite3_api->db_readonly +#define tdsqlite3_db_release_memory tdsqlite3_api->db_release_memory +#define tdsqlite3_errstr tdsqlite3_api->errstr +#define tdsqlite3_stmt_busy tdsqlite3_api->stmt_busy +#define tdsqlite3_stmt_readonly tdsqlite3_api->stmt_readonly +#define tdsqlite3_stricmp tdsqlite3_api->stricmp +#define tdsqlite3_uri_boolean tdsqlite3_api->uri_boolean +#define tdsqlite3_uri_int64 tdsqlite3_api->uri_int64 +#define tdsqlite3_uri_parameter tdsqlite3_api->uri_parameter +#define tdsqlite3_uri_vsnprintf tdsqlite3_api->xvsnprintf +#define tdsqlite3_wal_checkpoint_v2 tdsqlite3_api->wal_checkpoint_v2 +/* Version 3.8.7 and later */ +#define tdsqlite3_auto_extension tdsqlite3_api->auto_extension +#define tdsqlite3_bind_blob64 tdsqlite3_api->bind_blob64 +#define tdsqlite3_bind_text64 tdsqlite3_api->bind_text64 +#define tdsqlite3_cancel_auto_extension tdsqlite3_api->cancel_auto_extension +#define tdsqlite3_load_extension tdsqlite3_api->load_extension +#define tdsqlite3_malloc64 tdsqlite3_api->malloc64 +#define tdsqlite3_msize tdsqlite3_api->msize +#define tdsqlite3_realloc64 tdsqlite3_api->realloc64 +#define tdsqlite3_reset_auto_extension tdsqlite3_api->reset_auto_extension +#define tdsqlite3_result_blob64 tdsqlite3_api->result_blob64 +#define tdsqlite3_result_text64 tdsqlite3_api->result_text64 +#define tdsqlite3_strglob tdsqlite3_api->strglob +/* Version 3.8.11 and later */ +#define tdsqlite3_value_dup tdsqlite3_api->value_dup +#define tdsqlite3_value_free tdsqlite3_api->value_free +#define tdsqlite3_result_zeroblob64 tdsqlite3_api->result_zeroblob64 +#define tdsqlite3_bind_zeroblob64 tdsqlite3_api->bind_zeroblob64 +/* Version 3.9.0 and later */ +#define tdsqlite3_value_subtype tdsqlite3_api->value_subtype +#define tdsqlite3_result_subtype tdsqlite3_api->result_subtype +/* Version 3.10.0 and later */ +#define tdsqlite3_status64 tdsqlite3_api->status64 +#define tdsqlite3_strlike tdsqlite3_api->strlike +#define tdsqlite3_db_cacheflush tdsqlite3_api->db_cacheflush +/* Version 3.12.0 and later */ +#define tdsqlite3_system_errno tdsqlite3_api->system_errno +/* Version 3.14.0 and later */ +#define tdsqlite3_trace_v2 tdsqlite3_api->trace_v2 +#define tdsqlite3_expanded_sql tdsqlite3_api->expanded_sql +/* Version 3.18.0 and later */ +#define tdsqlite3_set_last_insert_rowid tdsqlite3_api->set_last_insert_rowid +/* Version 3.20.0 and later */ +#define tdsqlite3_prepare_v3 tdsqlite3_api->prepare_v3 +#define tdsqlite3_prepare16_v3 tdsqlite3_api->prepare16_v3 +#define tdsqlite3_bind_pointer tdsqlite3_api->bind_pointer +#define tdsqlite3_result_pointer tdsqlite3_api->result_pointer +#define tdsqlite3_value_pointer tdsqlite3_api->value_pointer +/* Version 3.22.0 and later */ +#define tdsqlite3_vtab_nochange tdsqlite3_api->vtab_nochange +#define tdsqlite3_value_nochange tdsqlite3_api->value_nochange +#define tdsqlite3_vtab_collation tdsqlite3_api->vtab_collation +/* Version 3.24.0 and later */ +#define tdsqlite3_keyword_count tdsqlite3_api->keyword_count +#define tdsqlite3_keyword_name tdsqlite3_api->keyword_name +#define tdsqlite3_keyword_check tdsqlite3_api->keyword_check +#define tdsqlite3_str_new tdsqlite3_api->str_new +#define tdsqlite3_str_finish tdsqlite3_api->str_finish +#define tdsqlite3_str_appendf tdsqlite3_api->str_appendf +#define tdsqlite3_str_vappendf tdsqlite3_api->str_vappendf +#define tdsqlite3_str_append tdsqlite3_api->str_append +#define tdsqlite3_str_appendall tdsqlite3_api->str_appendall +#define tdsqlite3_str_appendchar tdsqlite3_api->str_appendchar +#define tdsqlite3_str_reset tdsqlite3_api->str_reset +#define tdsqlite3_str_errcode tdsqlite3_api->str_errcode +#define tdsqlite3_str_length tdsqlite3_api->str_length +#define tdsqlite3_str_value tdsqlite3_api->str_value +/* Version 3.25.0 and later */ +#define tdsqlite3_create_window_function tdsqlite3_api->create_window_function +/* Version 3.26.0 and later */ +#define tdsqlite3_normalized_sql tdsqlite3_api->normalized_sql +/* Version 3.28.0 and later */ +#define tdsqlite3_stmt_isexplain tdsqlite3_api->isexplain +#define tdsqlite3_value_frombind tdsqlite3_api->frombind +/* Version 3.30.0 and later */ +#define tdsqlite3_drop_modules tdsqlite3_api->drop_modules +/* Version 3.31.0 andn later */ +#define tdsqlite3_hard_heap_limit64 tdsqlite3_api->hard_heap_limit64 +#define tdsqlite3_uri_key tdsqlite3_api->uri_key +#define tdsqlite3_filename_database tdsqlite3_api->filename_database +#define tdsqlite3_filename_journal tdsqlite3_api->filename_journal +#define tdsqlite3_filename_wal tdsqlite3_api->filename_wal +#endif /* !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION) */ + +#if !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION) + /* This case when the file really is being compiled as a loadable + ** extension */ +# define SQLITE_EXTENSION_INIT1 const tdsqlite3_api_routines *tdsqlite3_api=0; +# define SQLITE_EXTENSION_INIT2(v) tdsqlite3_api=v; +# define SQLITE_EXTENSION_INIT3 \ + extern const tdsqlite3_api_routines *tdsqlite3_api; +#else + /* This case when the file is being statically linked into the + ** application */ +# define SQLITE_EXTENSION_INIT1 /*no-op*/ +# define SQLITE_EXTENSION_INIT2(v) (void)v; /* unused parameter */ +# define SQLITE_EXTENSION_INIT3 /*no-op*/ +#endif + +#endif /* SQLITE3EXT_H */ diff --git a/third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3session.h b/third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3session.h new file mode 100644 index 0000000000..5ad10cd56e --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/sqlite/sqlite/sqlite3session.h @@ -0,0 +1,1659 @@ +#if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) +#define __SQLITESESSION_H_ 1 + +/* +** Make sure we can call this stuff from C++. +*/ +#ifdef __cplusplus +extern "C" { +#endif + +#include "sqlite3.h" + +/* +** CAPI3REF: Session Object Handle +** +** An instance of this object is a [session] that can be used to +** record changes to a database. +*/ +typedef struct tdsqlite3_session tdsqlite3_session; + +/* +** CAPI3REF: Changeset Iterator Handle +** +** An instance of this object acts as a cursor for iterating +** over the elements of a [changeset] or [patchset]. +*/ +typedef struct tdsqlite3_changeset_iter tdsqlite3_changeset_iter; + +/* +** CAPI3REF: Create A New Session Object +** CONSTRUCTOR: tdsqlite3_session +** +** Create a new session object attached to database handle db. If successful, +** a pointer to the new object is written to *ppSession and SQLITE_OK is +** returned. If an error occurs, *ppSession is set to NULL and an SQLite +** error code (e.g. SQLITE_NOMEM) is returned. +** +** It is possible to create multiple session objects attached to a single +** database handle. +** +** Session objects created using this function should be deleted using the +** [tdsqlite3session_delete()] function before the database handle that they +** are attached to is itself closed. If the database handle is closed before +** the session object is deleted, then the results of calling any session +** module function, including [tdsqlite3session_delete()] on the session object +** are undefined. +** +** Because the session module uses the [tdsqlite3_preupdate_hook()] API, it +** is not possible for an application to register a pre-update hook on a +** database handle that has one or more session objects attached. Nor is +** it possible to create a session object attached to a database handle for +** which a pre-update hook is already defined. The results of attempting +** either of these things are undefined. +** +** The session object will be used to create changesets for tables in +** database zDb, where zDb is either "main", or "temp", or the name of an +** attached database. It is not an error if database zDb is not attached +** to the database when the session object is created. +*/ +int tdsqlite3session_create( + tdsqlite3 *db, /* Database handle */ + const char *zDb, /* Name of db (e.g. "main") */ + tdsqlite3_session **ppSession /* OUT: New session object */ +); + +/* +** CAPI3REF: Delete A Session Object +** DESTRUCTOR: tdsqlite3_session +** +** Delete a session object previously allocated using +** [tdsqlite3session_create()]. Once a session object has been deleted, the +** results of attempting to use pSession with any other session module +** function are undefined. +** +** Session objects must be deleted before the database handle to which they +** are attached is closed. Refer to the documentation for +** [tdsqlite3session_create()] for details. +*/ +void tdsqlite3session_delete(tdsqlite3_session *pSession); + + +/* +** CAPI3REF: Enable Or Disable A Session Object +** METHOD: tdsqlite3_session +** +** Enable or disable the recording of changes by a session object. When +** enabled, a session object records changes made to the database. When +** disabled - it does not. A newly created session object is enabled. +** Refer to the documentation for [tdsqlite3session_changeset()] for further +** details regarding how enabling and disabling a session object affects +** the eventual changesets. +** +** Passing zero to this function disables the session. Passing a value +** greater than zero enables it. Passing a value less than zero is a +** no-op, and may be used to query the current state of the session. +** +** The return value indicates the final state of the session object: 0 if +** the session is disabled, or 1 if it is enabled. +*/ +int tdsqlite3session_enable(tdsqlite3_session *pSession, int bEnable); + +/* +** CAPI3REF: Set Or Clear the Indirect Change Flag +** METHOD: tdsqlite3_session +** +** Each change recorded by a session object is marked as either direct or +** indirect. A change is marked as indirect if either: +** +**
    +**
  • The session object "indirect" flag is set when the change is +** made, or +**
  • The change is made by an SQL trigger or foreign key action +** instead of directly as a result of a users SQL statement. +**
+** +** If a single row is affected by more than one operation within a session, +** then the change is considered indirect if all operations meet the criteria +** for an indirect change above, or direct otherwise. +** +** This function is used to set, clear or query the session object indirect +** flag. If the second argument passed to this function is zero, then the +** indirect flag is cleared. If it is greater than zero, the indirect flag +** is set. Passing a value less than zero does not modify the current value +** of the indirect flag, and may be used to query the current state of the +** indirect flag for the specified session object. +** +** The return value indicates the final state of the indirect flag: 0 if +** it is clear, or 1 if it is set. +*/ +int tdsqlite3session_indirect(tdsqlite3_session *pSession, int bIndirect); + +/* +** CAPI3REF: Attach A Table To A Session Object +** METHOD: tdsqlite3_session +** +** If argument zTab is not NULL, then it is the name of a table to attach +** to the session object passed as the first argument. All subsequent changes +** made to the table while the session object is enabled will be recorded. See +** documentation for [tdsqlite3session_changeset()] for further details. +** +** Or, if argument zTab is NULL, then changes are recorded for all tables +** in the database. If additional tables are added to the database (by +** executing "CREATE TABLE" statements) after this call is made, changes for +** the new tables are also recorded. +** +** Changes can only be recorded for tables that have a PRIMARY KEY explicitly +** defined as part of their CREATE TABLE statement. It does not matter if the +** PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY +** KEY may consist of a single column, or may be a composite key. +** +** It is not an error if the named table does not exist in the database. Nor +** is it an error if the named table does not have a PRIMARY KEY. However, +** no changes will be recorded in either of these scenarios. +** +** Changes are not recorded for individual rows that have NULL values stored +** in one or more of their PRIMARY KEY columns. +** +** SQLITE_OK is returned if the call completes without error. Or, if an error +** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned. +** +**

Special sqlite_stat1 Handling

+** +** As of SQLite version 3.22.0, the "sqlite_stat1" table is an exception to +** some of the rules above. In SQLite, the schema of sqlite_stat1 is: +** 
+**        CREATE TABLE sqlite_stat1(tbl,idx,stat)  
+**
+** +** Even though sqlite_stat1 does not have a PRIMARY KEY, changes are +** recorded for it as if the PRIMARY KEY is (tbl,idx). Additionally, changes +** are recorded for rows for which (idx IS NULL) is true. However, for such +** rows a zero-length blob (SQL value X'') is stored in the changeset or +** patchset instead of a NULL value. This allows such changesets to be +** manipulated by legacy implementations of tdsqlite3changeset_invert(), +** concat() and similar. +** +** The tdsqlite3changeset_apply() function automatically converts the +** zero-length blob back to a NULL value when updating the sqlite_stat1 +** table. However, if the application calls tdsqlite3changeset_new(), +** tdsqlite3changeset_old() or tdsqlite3changeset_conflict on a changeset +** iterator directly (including on a changeset iterator passed to a +** conflict-handler callback) then the X'' value is returned. The application +** must translate X'' to NULL itself if required. +** +** Legacy (older than 3.22.0) versions of the sessions module cannot capture +** changes made to the sqlite_stat1 table. Legacy versions of the +** tdsqlite3changeset_apply() function silently ignore any modifications to the +** sqlite_stat1 table that are part of a changeset or patchset. +*/ +int tdsqlite3session_attach( + tdsqlite3_session *pSession, /* Session object */ + const char *zTab /* Table name */ +); + +/* +** CAPI3REF: Set a table filter on a Session Object. +** METHOD: tdsqlite3_session +** +** The second argument (xFilter) is the "filter callback". For changes to rows +** in tables that are not attached to the Session object, the filter is called +** to determine whether changes to the table's rows should be tracked or not. +** If xFilter returns 0, changes are not tracked. Note that once a table is +** attached, xFilter will not be called again. +*/ +void tdsqlite3session_table_filter( + tdsqlite3_session *pSession, /* Session object */ + int(*xFilter)( + void *pCtx, /* Copy of third arg to _filter_table() */ + const char *zTab /* Table name */ + ), + void *pCtx /* First argument passed to xFilter */ +); + +/* +** CAPI3REF: Generate A Changeset From A Session Object +** METHOD: tdsqlite3_session +** +** Obtain a changeset containing changes to the tables attached to the +** session object passed as the first argument. If successful, +** set *ppChangeset to point to a buffer containing the changeset +** and *pnChangeset to the size of the changeset in bytes before returning +** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to +** zero and return an SQLite error code. +** +** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes, +** each representing a change to a single row of an attached table. An INSERT +** change contains the values of each field of a new database row. A DELETE +** contains the original values of each field of a deleted database row. An +** UPDATE change contains the original values of each field of an updated +** database row along with the updated values for each updated non-primary-key +** column. It is not possible for an UPDATE change to represent a change that +** modifies the values of primary key columns. If such a change is made, it +** is represented in a changeset as a DELETE followed by an INSERT. +** +** Changes are not recorded for rows that have NULL values stored in one or +** more of their PRIMARY KEY columns. If such a row is inserted or deleted, +** no corresponding change is present in the changesets returned by this +** function. If an existing row with one or more NULL values stored in +** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL, +** only an INSERT is appears in the changeset. Similarly, if an existing row +** with non-NULL PRIMARY KEY values is updated so that one or more of its +** PRIMARY KEY columns are set to NULL, the resulting changeset contains a +** DELETE change only. +** +** The contents of a changeset may be traversed using an iterator created +** using the [tdsqlite3changeset_start()] API. A changeset may be applied to +** a database with a compatible schema using the [tdsqlite3changeset_apply()] +** API. +** +** Within a changeset generated by this function, all changes related to a +** single table are grouped together. In other words, when iterating through +** a changeset or when applying a changeset to a database, all changes related +** to a single table are processed before moving on to the next table. Tables +** are sorted in the same order in which they were attached (or auto-attached) +** to the tdsqlite3_session object. The order in which the changes related to +** a single table are stored is undefined. +** +** Following a successful call to this function, it is the responsibility of +** the caller to eventually free the buffer that *ppChangeset points to using +** [tdsqlite3_free()]. +** +**

Changeset Generation

+** +** Once a table has been attached to a session object, the session object +** records the primary key values of all new rows inserted into the table. +** It also records the original primary key and other column values of any +** deleted or updated rows. For each unique primary key value, data is only +** recorded once - the first time a row with said primary key is inserted, +** updated or deleted in the lifetime of the session. +** +** There is one exception to the previous paragraph: when a row is inserted, +** updated or deleted, if one or more of its primary key columns contain a +** NULL value, no record of the change is made. +** +** The session object therefore accumulates two types of records - those +** that consist of primary key values only (created when the user inserts +** a new record) and those that consist of the primary key values and the +** original values of other table columns (created when the users deletes +** or updates a record). +** +** When this function is called, the requested changeset is created using +** both the accumulated records and the current contents of the database +** file. Specifically: +** +**
    +**
  • For each record generated by an insert, the database is queried +** for a row with a matching primary key. If one is found, an INSERT +** change is added to the changeset. If no such row is found, no change +** is added to the changeset. +** +**
  • For each record generated by an update or delete, the database is +** queried for a row with a matching primary key. If such a row is +** found and one or more of the non-primary key fields have been +** modified from their original values, an UPDATE change is added to +** the changeset. Or, if no such row is found in the table, a DELETE +** change is added to the changeset. If there is a row with a matching +** primary key in the database, but all fields contain their original +** values, no change is added to the changeset. +**
+** +** This means, amongst other things, that if a row is inserted and then later +** deleted while a session object is active, neither the insert nor the delete +** will be present in the changeset. Or if a row is deleted and then later a +** row with the same primary key values inserted while a session object is +** active, the resulting changeset will contain an UPDATE change instead of +** a DELETE and an INSERT. +** +** When a session object is disabled (see the [tdsqlite3session_enable()] API), +** it does not accumulate records when rows are inserted, updated or deleted. +** This may appear to have some counter-intuitive effects if a single row +** is written to more than once during a session. For example, if a row +** is inserted while a session object is enabled, then later deleted while +** the same session object is disabled, no INSERT record will appear in the +** changeset, even though the delete took place while the session was disabled. +** Or, if one field of a row is updated while a session is disabled, and +** another field of the same row is updated while the session is enabled, the +** resulting changeset will contain an UPDATE change that updates both fields. +*/ +int tdsqlite3session_changeset( + tdsqlite3_session *pSession, /* Session object */ + int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */ + void **ppChangeset /* OUT: Buffer containing changeset */ +); + +/* +** CAPI3REF: Load The Difference Between Tables Into A Session +** METHOD: tdsqlite3_session +** +** If it is not already attached to the session object passed as the first +** argument, this function attaches table zTbl in the same manner as the +** [tdsqlite3session_attach()] function. If zTbl does not exist, or if it +** does not have a primary key, this function is a no-op (but does not return +** an error). +** +** Argument zFromDb must be the name of a database ("main", "temp" etc.) +** attached to the same database handle as the session object that contains +** a table compatible with the table attached to the session by this function. +** A table is considered compatible if it: +** +**
    +**
  • Has the same name, +**
  • Has the same set of columns declared in the same order, and +**
  • Has the same PRIMARY KEY definition. +**
+** +** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables +** are compatible but do not have any PRIMARY KEY columns, it is not an error +** but no changes are added to the session object. As with other session +** APIs, tables without PRIMARY KEYs are simply ignored. +** +** This function adds a set of changes to the session object that could be +** used to update the table in database zFrom (call this the "from-table") +** so that its content is the same as the table attached to the session +** object (call this the "to-table"). Specifically: +** +**
    +**
  • For each row (primary key) that exists in the to-table but not in +** the from-table, an INSERT record is added to the session object. +** +**
  • For each row (primary key) that exists in the to-table but not in +** the from-table, a DELETE record is added to the session object. +** +**
  • For each row (primary key) that exists in both tables, but features +** different non-PK values in each, an UPDATE record is added to the +** session. +**
+** +** To clarify, if this function is called and then a changeset constructed +** using [tdsqlite3session_changeset()], then after applying that changeset to +** database zFrom the contents of the two compatible tables would be +** identical. +** +** It an error if database zFrom does not exist or does not contain the +** required compatible table. +** +** If the operation is successful, SQLITE_OK is returned. Otherwise, an SQLite +** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg +** may be set to point to a buffer containing an English language error +** message. It is the responsibility of the caller to free this buffer using +** tdsqlite3_free(). +*/ +int tdsqlite3session_diff( + tdsqlite3_session *pSession, + const char *zFromDb, + const char *zTbl, + char **pzErrMsg +); + + +/* +** CAPI3REF: Generate A Patchset From A Session Object +** METHOD: tdsqlite3_session +** +** The differences between a patchset and a changeset are that: +** +**
    +**
  • DELETE records consist of the primary key fields only. The +** original values of other fields are omitted. +**
  • The original values of any modified fields are omitted from +** UPDATE records. +**
+** +** A patchset blob may be used with up to date versions of all +** tdsqlite3changeset_xxx API functions except for tdsqlite3changeset_invert(), +** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly, +** attempting to use a patchset blob with old versions of the +** tdsqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error. +** +** Because the non-primary key "old.*" fields are omitted, no +** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset +** is passed to the tdsqlite3changeset_apply() API. Other conflict types work +** in the same way as for changesets. +** +** Changes within a patchset are ordered in the same way as for changesets +** generated by the tdsqlite3session_changeset() function (i.e. all changes for +** a single table are grouped together, tables appear in the order in which +** they were attached to the session object). +*/ +int tdsqlite3session_patchset( + tdsqlite3_session *pSession, /* Session object */ + int *pnPatchset, /* OUT: Size of buffer at *ppPatchset */ + void **ppPatchset /* OUT: Buffer containing patchset */ +); + +/* +** CAPI3REF: Test if a changeset has recorded any changes. +** +** Return non-zero if no changes to attached tables have been recorded by +** the session object passed as the first argument. Otherwise, if one or +** more changes have been recorded, return zero. +** +** Even if this function returns zero, it is possible that calling +** [tdsqlite3session_changeset()] on the session handle may still return a +** changeset that contains no changes. This can happen when a row in +** an attached table is modified and then later on the original values +** are restored. However, if this function returns non-zero, then it is +** guaranteed that a call to tdsqlite3session_changeset() will return a +** changeset containing zero changes. +*/ +int tdsqlite3session_isempty(tdsqlite3_session *pSession); + +/* +** CAPI3REF: Create An Iterator To Traverse A Changeset +** CONSTRUCTOR: tdsqlite3_changeset_iter +** +** Create an iterator used to iterate through the contents of a changeset. +** If successful, *pp is set to point to the iterator handle and SQLITE_OK +** is returned. Otherwise, if an error occurs, *pp is set to zero and an +** SQLite error code is returned. +** +** The following functions can be used to advance and query a changeset +** iterator created by this function: +** +**
    +**
  • [tdsqlite3changeset_next()] +**
  • [tdsqlite3changeset_op()] +**
  • [tdsqlite3changeset_new()] +**
  • [tdsqlite3changeset_old()] +**
+** +** It is the responsibility of the caller to eventually destroy the iterator +** by passing it to [tdsqlite3changeset_finalize()]. The buffer containing the +** changeset (pChangeset) must remain valid until after the iterator is +** destroyed. +** +** Assuming the changeset blob was created by one of the +** [tdsqlite3session_changeset()], [tdsqlite3changeset_concat()] or +** [tdsqlite3changeset_invert()] functions, all changes within the changeset +** that apply to a single table are grouped together. This means that when +** an application iterates through a changeset using an iterator created by +** this function, all changes that relate to a single table are visited +** consecutively. There is no chance that the iterator will visit a change +** the applies to table X, then one for table Y, and then later on visit +** another change for table X. +** +** The behavior of tdsqlite3changeset_start_v2() and its streaming equivalent +** may be modified by passing a combination of +** [SQLITE_CHANGESETSTART_INVERT | supported flags] as the 4th parameter. +** +** Note that the tdsqlite3changeset_start_v2() API is still experimental +** and therefore subject to change. +*/ +int tdsqlite3changeset_start( + tdsqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */ + int nChangeset, /* Size of changeset blob in bytes */ + void *pChangeset /* Pointer to blob containing changeset */ +); +int tdsqlite3changeset_start_v2( + tdsqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */ + int nChangeset, /* Size of changeset blob in bytes */ + void *pChangeset, /* Pointer to blob containing changeset */ + int flags /* SESSION_CHANGESETSTART_* flags */ +); + +/* +** CAPI3REF: Flags for tdsqlite3changeset_start_v2 +** +** The following flags may passed via the 4th parameter to +** [tdsqlite3changeset_start_v2] and [tdsqlite3changeset_start_v2_strm]: +** +**
SQLITE_CHANGESETAPPLY_INVERT
+** Invert the changeset while iterating through it. This is equivalent to +** inverting a changeset using tdsqlite3changeset_invert() before applying it. +** It is an error to specify this flag with a patchset. +*/ +#define SQLITE_CHANGESETSTART_INVERT 0x0002 + + +/* +** CAPI3REF: Advance A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** This function may only be used with iterators created by the function +** [tdsqlite3changeset_start()]. If it is called on an iterator passed to +** a conflict-handler callback by [tdsqlite3changeset_apply()], SQLITE_MISUSE +** is returned and the call has no effect. +** +** Immediately after an iterator is created by tdsqlite3changeset_start(), it +** does not point to any change in the changeset. Assuming the changeset +** is not empty, the first call to this function advances the iterator to +** point to the first change in the changeset. Each subsequent call advances +** the iterator to point to the next change in the changeset (if any). If +** no error occurs and the iterator points to a valid change after a call +** to tdsqlite3changeset_next() has advanced it, SQLITE_ROW is returned. +** Otherwise, if all changes in the changeset have already been visited, +** SQLITE_DONE is returned. +** +** If an error occurs, an SQLite error code is returned. Possible error +** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or +** SQLITE_NOMEM. +*/ +int tdsqlite3changeset_next(tdsqlite3_changeset_iter *pIter); + +/* +** CAPI3REF: Obtain The Current Operation From A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** The pIter argument passed to this function may either be an iterator +** passed to a conflict-handler by [tdsqlite3changeset_apply()], or an iterator +** created by [tdsqlite3changeset_start()]. In the latter case, the most recent +** call to [tdsqlite3changeset_next()] must have returned [SQLITE_ROW]. If this +** is not the case, this function returns [SQLITE_MISUSE]. +** +** If argument pzTab is not NULL, then *pzTab is set to point to a +** nul-terminated utf-8 encoded string containing the name of the table +** affected by the current change. The buffer remains valid until either +** tdsqlite3changeset_next() is called on the iterator or until the +** conflict-handler function returns. If pnCol is not NULL, then *pnCol is +** set to the number of columns in the table affected by the change. If +** pbIndirect is not NULL, then *pbIndirect is set to true (1) if the change +** is an indirect change, or false (0) otherwise. See the documentation for +** [tdsqlite3session_indirect()] for a description of direct and indirect +** changes. Finally, if pOp is not NULL, then *pOp is set to one of +** [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], depending on the +** type of change that the iterator currently points to. +** +** If no error occurs, SQLITE_OK is returned. If an error does occur, an +** SQLite error code is returned. The values of the output variables may not +** be trusted in this case. +*/ +int tdsqlite3changeset_op( + tdsqlite3_changeset_iter *pIter, /* Iterator object */ + const char **pzTab, /* OUT: Pointer to table name */ + int *pnCol, /* OUT: Number of columns in table */ + int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */ + int *pbIndirect /* OUT: True for an 'indirect' change */ +); + +/* +** CAPI3REF: Obtain The Primary Key Definition Of A Table +** METHOD: tdsqlite3_changeset_iter +** +** For each modified table, a changeset includes the following: +** +**
    +**
  • The number of columns in the table, and +**
  • Which of those columns make up the tables PRIMARY KEY. +**
+** +** This function is used to find which columns comprise the PRIMARY KEY of +** the table modified by the change that iterator pIter currently points to. +** If successful, *pabPK is set to point to an array of nCol entries, where +** nCol is the number of columns in the table. Elements of *pabPK are set to +** 0x01 if the corresponding column is part of the tables primary key, or +** 0x00 if it is not. +** +** If argument pnCol is not NULL, then *pnCol is set to the number of columns +** in the table. +** +** If this function is called when the iterator does not point to a valid +** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise, +** SQLITE_OK is returned and the output variables populated as described +** above. +*/ +int tdsqlite3changeset_pk( + tdsqlite3_changeset_iter *pIter, /* Iterator object */ + unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */ + int *pnCol /* OUT: Number of entries in output array */ +); + +/* +** CAPI3REF: Obtain old.* Values From A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** The pIter argument passed to this function may either be an iterator +** passed to a conflict-handler by [tdsqlite3changeset_apply()], or an iterator +** created by [tdsqlite3changeset_start()]. In the latter case, the most recent +** call to [tdsqlite3changeset_next()] must have returned SQLITE_ROW. +** Furthermore, it may only be called if the type of change that the iterator +** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise, +** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL. +** +** Argument iVal must be greater than or equal to 0, and less than the number +** of columns in the table affected by the current change. Otherwise, +** [SQLITE_RANGE] is returned and *ppValue is set to NULL. +** +** If successful, this function sets *ppValue to point to a protected +** tdsqlite3_value object containing the iVal'th value from the vector of +** original row values stored as part of the UPDATE or DELETE change and +** returns SQLITE_OK. The name of the function comes from the fact that this +** is similar to the "old.*" columns available to update or delete triggers. +** +** If some other error occurs (e.g. an OOM condition), an SQLite error code +** is returned and *ppValue is set to NULL. +*/ +int tdsqlite3changeset_old( + tdsqlite3_changeset_iter *pIter, /* Changeset iterator */ + int iVal, /* Column number */ + tdsqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */ +); + +/* +** CAPI3REF: Obtain new.* Values From A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** The pIter argument passed to this function may either be an iterator +** passed to a conflict-handler by [tdsqlite3changeset_apply()], or an iterator +** created by [tdsqlite3changeset_start()]. In the latter case, the most recent +** call to [tdsqlite3changeset_next()] must have returned SQLITE_ROW. +** Furthermore, it may only be called if the type of change that the iterator +** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise, +** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL. +** +** Argument iVal must be greater than or equal to 0, and less than the number +** of columns in the table affected by the current change. Otherwise, +** [SQLITE_RANGE] is returned and *ppValue is set to NULL. +** +** If successful, this function sets *ppValue to point to a protected +** tdsqlite3_value object containing the iVal'th value from the vector of +** new row values stored as part of the UPDATE or INSERT change and +** returns SQLITE_OK. If the change is an UPDATE and does not include +** a new value for the requested column, *ppValue is set to NULL and +** SQLITE_OK returned. The name of the function comes from the fact that +** this is similar to the "new.*" columns available to update or delete +** triggers. +** +** If some other error occurs (e.g. an OOM condition), an SQLite error code +** is returned and *ppValue is set to NULL. +*/ +int tdsqlite3changeset_new( + tdsqlite3_changeset_iter *pIter, /* Changeset iterator */ + int iVal, /* Column number */ + tdsqlite3_value **ppValue /* OUT: New value (or NULL pointer) */ +); + +/* +** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** This function should only be used with iterator objects passed to a +** conflict-handler callback by [tdsqlite3changeset_apply()] with either +** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function +** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue +** is set to NULL. +** +** Argument iVal must be greater than or equal to 0, and less than the number +** of columns in the table affected by the current change. Otherwise, +** [SQLITE_RANGE] is returned and *ppValue is set to NULL. +** +** If successful, this function sets *ppValue to point to a protected +** tdsqlite3_value object containing the iVal'th value from the +** "conflicting row" associated with the current conflict-handler callback +** and returns SQLITE_OK. +** +** If some other error occurs (e.g. an OOM condition), an SQLite error code +** is returned and *ppValue is set to NULL. +*/ +int tdsqlite3changeset_conflict( + tdsqlite3_changeset_iter *pIter, /* Changeset iterator */ + int iVal, /* Column number */ + tdsqlite3_value **ppValue /* OUT: Value from conflicting row */ +); + +/* +** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations +** METHOD: tdsqlite3_changeset_iter +** +** This function may only be called with an iterator passed to an +** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case +** it sets the output variable to the total number of known foreign key +** violations in the destination database and returns SQLITE_OK. +** +** In all other cases this function returns SQLITE_MISUSE. +*/ +int tdsqlite3changeset_fk_conflicts( + tdsqlite3_changeset_iter *pIter, /* Changeset iterator */ + int *pnOut /* OUT: Number of FK violations */ +); + + +/* +** CAPI3REF: Finalize A Changeset Iterator +** METHOD: tdsqlite3_changeset_iter +** +** This function is used to finalize an iterator allocated with +** [tdsqlite3changeset_start()]. +** +** This function should only be called on iterators created using the +** [tdsqlite3changeset_start()] function. If an application calls this +** function with an iterator passed to a conflict-handler by +** [tdsqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the +** call has no effect. +** +** If an error was encountered within a call to an tdsqlite3changeset_xxx() +** function (for example an [SQLITE_CORRUPT] in [tdsqlite3changeset_next()] or an +** [SQLITE_NOMEM] in [tdsqlite3changeset_new()]) then an error code corresponding +** to that error is returned by this function. Otherwise, SQLITE_OK is +** returned. This is to allow the following pattern (pseudo-code): +** +** 
+**   tdsqlite3changeset_start();
+**   while( SQLITE_ROW==tdsqlite3changeset_next() ){
+**     // Do something with change.
+**   }
+**   rc = tdsqlite3changeset_finalize();
+**   if( rc!=SQLITE_OK ){
+**     // An error has occurred 
+**   }
+**
+*/ +int tdsqlite3changeset_finalize(tdsqlite3_changeset_iter *pIter); + +/* +** CAPI3REF: Invert A Changeset +** +** This function is used to "invert" a changeset object. Applying an inverted +** changeset to a database reverses the effects of applying the uninverted +** changeset. Specifically: +** +**
    +**
  • Each DELETE change is changed to an INSERT, and +**
  • Each INSERT change is changed to a DELETE, and +**
  • For each UPDATE change, the old.* and new.* values are exchanged. +**
+** +** This function does not change the order in which changes appear within +** the changeset. It merely reverses the sense of each individual change. +** +** If successful, a pointer to a buffer containing the inverted changeset +** is stored in *ppOut, the size of the same buffer is stored in *pnOut, and +** SQLITE_OK is returned. If an error occurs, both *pnOut and *ppOut are +** zeroed and an SQLite error code returned. +** +** It is the responsibility of the caller to eventually call tdsqlite3_free() +** on the *ppOut pointer to free the buffer allocation following a successful +** call to this function. +** +** WARNING/TODO: This function currently assumes that the input is a valid +** changeset. If it is not, the results are undefined. +*/ +int tdsqlite3changeset_invert( + int nIn, const void *pIn, /* Input changeset */ + int *pnOut, void **ppOut /* OUT: Inverse of input */ +); + +/* +** CAPI3REF: Concatenate Two Changeset Objects +** +** This function is used to concatenate two changesets, A and B, into a +** single changeset. The result is a changeset equivalent to applying +** changeset A followed by changeset B. +** +** This function combines the two input changesets using an +** tdsqlite3_changegroup object. Calling it produces similar results as the +** following code fragment: +** +** 
+**   tdsqlite3_changegroup *pGrp;
+**   rc = tdsqlite3_changegroup_new(&pGrp);
+**   if( rc==SQLITE_OK ) rc = tdsqlite3changegroup_add(pGrp, nA, pA);
+**   if( rc==SQLITE_OK ) rc = tdsqlite3changegroup_add(pGrp, nB, pB);
+**   if( rc==SQLITE_OK ){
+**     rc = tdsqlite3changegroup_output(pGrp, pnOut, ppOut);
+**   }else{
+**     *ppOut = 0;
+**     *pnOut = 0;
+**   }
+**
+** +** Refer to the tdsqlite3_changegroup documentation below for details. +*/ +int tdsqlite3changeset_concat( + int nA, /* Number of bytes in buffer pA */ + void *pA, /* Pointer to buffer containing changeset A */ + int nB, /* Number of bytes in buffer pB */ + void *pB, /* Pointer to buffer containing changeset B */ + int *pnOut, /* OUT: Number of bytes in output changeset */ + void **ppOut /* OUT: Buffer containing output changeset */ +); + + +/* +** CAPI3REF: Changegroup Handle +** +** A changegroup is an object used to combine two or more +** [changesets] or [patchsets] +*/ +typedef struct tdsqlite3_changegroup tdsqlite3_changegroup; + +/* +** CAPI3REF: Create A New Changegroup Object +** CONSTRUCTOR: tdsqlite3_changegroup +** +** An tdsqlite3_changegroup object is used to combine two or more changesets +** (or patchsets) into a single changeset (or patchset). A single changegroup +** object may combine changesets or patchsets, but not both. The output is +** always in the same format as the input. +** +** If successful, this function returns SQLITE_OK and populates (*pp) with +** a pointer to a new tdsqlite3_changegroup object before returning. The caller +** should eventually free the returned object using a call to +** tdsqlite3changegroup_delete(). If an error occurs, an SQLite error code +** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL. +** +** The usual usage pattern for an tdsqlite3_changegroup object is as follows: +** +**
    +**
  • It is created using a call to tdsqlite3changegroup_new(). +** +**
  • Zero or more changesets (or patchsets) are added to the object +** by calling tdsqlite3changegroup_add(). +** +**
  • The result of combining all input changesets together is obtained +** by the application via a call to tdsqlite3changegroup_output(). +** +**
  • The object is deleted using a call to tdsqlite3changegroup_delete(). +**
+** +** Any number of calls to add() and output() may be made between the calls to +** new() and delete(), and in any order. +** +** As well as the regular tdsqlite3changegroup_add() and +** tdsqlite3changegroup_output() functions, also available are the streaming +** versions tdsqlite3changegroup_add_strm() and tdsqlite3changegroup_output_strm(). +*/ +int tdsqlite3changegroup_new(tdsqlite3_changegroup **pp); + +/* +** CAPI3REF: Add A Changeset To A Changegroup +** METHOD: tdsqlite3_changegroup +** +** Add all changes within the changeset (or patchset) in buffer pData (size +** nData bytes) to the changegroup. +** +** If the buffer contains a patchset, then all prior calls to this function +** on the same changegroup object must also have specified patchsets. Or, if +** the buffer contains a changeset, so must have the earlier calls to this +** function. Otherwise, SQLITE_ERROR is returned and no changes are added +** to the changegroup. +** +** Rows within the changeset and changegroup are identified by the values in +** their PRIMARY KEY columns. A change in the changeset is considered to +** apply to the same row as a change already present in the changegroup if +** the two rows have the same primary key. +** +** Changes to rows that do not already appear in the changegroup are +** simply copied into it. Or, if both the new changeset and the changegroup +** contain changes that apply to a single row, the final contents of the +** changegroup depends on the type of each change, as follows: +** +** +** +** +**
Existing Change New Change Output Change +**
INSERT INSERT +** The new change is ignored. This case does not occur if the new +** changeset was recorded immediately after the changesets already +** added to the changegroup. +**
INSERT UPDATE +** The INSERT change remains in the changegroup. The values in the +** INSERT change are modified as if the row was inserted by the +** existing change and then updated according to the new change. +**
INSERT DELETE +** The existing INSERT is removed from the changegroup. The DELETE is +** not added. +**
UPDATE INSERT +** The new change is ignored. This case does not occur if the new +** changeset was recorded immediately after the changesets already +** added to the changegroup. +**
UPDATE UPDATE +** The existing UPDATE remains within the changegroup. It is amended +** so that the accompanying values are as if the row was updated once +** by the existing change and then again by the new change. +**
UPDATE DELETE +** The existing UPDATE is replaced by the new DELETE within the +** changegroup. +**
DELETE INSERT +** If one or more of the column values in the row inserted by the +** new change differ from those in the row deleted by the existing +** change, the existing DELETE is replaced by an UPDATE within the +** changegroup. Otherwise, if the inserted row is exactly the same +** as the deleted row, the existing DELETE is simply discarded. +**
DELETE UPDATE +** The new change is ignored. This case does not occur if the new +** changeset was recorded immediately after the changesets already +** added to the changegroup. +**
DELETE DELETE +** The new change is ignored. This case does not occur if the new +** changeset was recorded immediately after the changesets already +** added to the changegroup. +**
+** +** If the new changeset contains changes to a table that is already present +** in the changegroup, then the number of columns and the position of the +** primary key columns for the table must be consistent. If this is not the +** case, this function fails with SQLITE_SCHEMA. If the input changeset +** appears to be corrupt and the corruption is detected, SQLITE_CORRUPT is +** returned. Or, if an out-of-memory condition occurs during processing, this +** function returns SQLITE_NOMEM. In all cases, if an error occurs the state +** of the final contents of the changegroup is undefined. +** +** If no error occurs, SQLITE_OK is returned. +*/ +int tdsqlite3changegroup_add(tdsqlite3_changegroup*, int nData, void *pData); + +/* +** CAPI3REF: Obtain A Composite Changeset From A Changegroup +** METHOD: tdsqlite3_changegroup +** +** Obtain a buffer containing a changeset (or patchset) representing the +** current contents of the changegroup. If the inputs to the changegroup +** were themselves changesets, the output is a changeset. Or, if the +** inputs were patchsets, the output is also a patchset. +** +** As with the output of the tdsqlite3session_changeset() and +** tdsqlite3session_patchset() functions, all changes related to a single +** table are grouped together in the output of this function. Tables appear +** in the same order as for the very first changeset added to the changegroup. +** If the second or subsequent changesets added to the changegroup contain +** changes for tables that do not appear in the first changeset, they are +** appended onto the end of the output changeset, again in the order in +** which they are first encountered. +** +** If an error occurs, an SQLite error code is returned and the output +** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK +** is returned and the output variables are set to the size of and a +** pointer to the output buffer, respectively. In this case it is the +** responsibility of the caller to eventually free the buffer using a +** call to tdsqlite3_free(). +*/ +int tdsqlite3changegroup_output( + tdsqlite3_changegroup*, + int *pnData, /* OUT: Size of output buffer in bytes */ + void **ppData /* OUT: Pointer to output buffer */ +); + +/* +** CAPI3REF: Delete A Changegroup Object +** DESTRUCTOR: tdsqlite3_changegroup +*/ +void tdsqlite3changegroup_delete(tdsqlite3_changegroup*); + +/* +** CAPI3REF: Apply A Changeset To A Database +** +** Apply a changeset or patchset to a database. These functions attempt to +** update the "main" database attached to handle db with the changes found in +** the changeset passed via the second and third arguments. +** +** The fourth argument (xFilter) passed to these functions is the "filter +** callback". If it is not NULL, then for each table affected by at least one +** change in the changeset, the filter callback is invoked with +** the table name as the second argument, and a copy of the context pointer +** passed as the sixth argument as the first. If the "filter callback" +** returns zero, then no attempt is made to apply any changes to the table. +** Otherwise, if the return value is non-zero or the xFilter argument to +** is NULL, all changes related to the table are attempted. +** +** For each table that is not excluded by the filter callback, this function +** tests that the target database contains a compatible table. A table is +** considered compatible if all of the following are true: +** +**
    +**
  • The table has the same name as the name recorded in the +** changeset, and +**
  • The table has at least as many columns as recorded in the +** changeset, and +**
  • The table has primary key columns in the same position as +** recorded in the changeset. +**
+** +** If there is no compatible table, it is not an error, but none of the +** changes associated with the table are applied. A warning message is issued +** via the tdsqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most +** one such warning is issued for each table in the changeset. +** +** For each change for which there is a compatible table, an attempt is made +** to modify the table contents according to the UPDATE, INSERT or DELETE +** change. If a change cannot be applied cleanly, the conflict handler +** function passed as the fifth argument to tdsqlite3changeset_apply() may be +** invoked. A description of exactly when the conflict handler is invoked for +** each type of change is below. +** +** Unlike the xFilter argument, xConflict may not be passed NULL. The results +** of passing anything other than a valid function pointer as the xConflict +** argument are undefined. +** +** Each time the conflict handler function is invoked, it must return one +** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or +** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned +** if the second argument passed to the conflict handler is either +** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler +** returns an illegal value, any changes already made are rolled back and +** the call to tdsqlite3changeset_apply() returns SQLITE_MISUSE. Different +** actions are taken by tdsqlite3changeset_apply() depending on the value +** returned by each invocation of the conflict-handler function. Refer to +** the documentation for the three +** [SQLITE_CHANGESET_OMIT|available return values] for details. +** +**
+**
DELETE Changes
+** For each DELETE change, the function checks if the target database +** contains a row with the same primary key value (or values) as the +** original row values stored in the changeset. If it does, and the values +** stored in all non-primary key columns also match the values stored in +** the changeset the row is deleted from the target database. +** +** If a row with matching primary key values is found, but one or more of +** the non-primary key fields contains a value different from the original +** row value stored in the changeset, the conflict-handler function is +** invoked with [SQLITE_CHANGESET_DATA] as the second argument. If the +** database table has more columns than are recorded in the changeset, +** only the values of those non-primary key fields are compared against +** the current database contents - any trailing database table columns +** are ignored. +** +** If no row with matching primary key values is found in the database, +** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND] +** passed as the second argument. +** +** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT +** (which can only happen if a foreign key constraint is violated), the +** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT] +** passed as the second argument. This includes the case where the DELETE +** operation is attempted because an earlier call to the conflict handler +** function returned [SQLITE_CHANGESET_REPLACE]. +** +**
INSERT Changes
+** For each INSERT change, an attempt is made to insert the new row into +** the database. If the changeset row contains fewer fields than the +** database table, the trailing fields are populated with their default +** values. +** +** If the attempt to insert the row fails because the database already +** contains a row with the same primary key values, the conflict handler +** function is invoked with the second argument set to +** [SQLITE_CHANGESET_CONFLICT]. +** +** If the attempt to insert the row fails because of some other constraint +** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is +** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT]. +** This includes the case where the INSERT operation is re-attempted because +** an earlier call to the conflict handler function returned +** [SQLITE_CHANGESET_REPLACE]. +** +**
UPDATE Changes
+** For each UPDATE change, the function checks if the target database +** contains a row with the same primary key value (or values) as the +** original row values stored in the changeset. If it does, and the values +** stored in all modified non-primary key columns also match the values +** stored in the changeset the row is updated within the target database. +** +** If a row with matching primary key values is found, but one or more of +** the modified non-primary key fields contains a value different from an +** original row value stored in the changeset, the conflict-handler function +** is invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since +** UPDATE changes only contain values for non-primary key fields that are +** to be modified, only those fields need to match the original values to +** avoid the SQLITE_CHANGESET_DATA conflict-handler callback. +** +** If no row with matching primary key values is found in the database, +** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND] +** passed as the second argument. +** +** If the UPDATE operation is attempted, but SQLite returns +** SQLITE_CONSTRAINT, the conflict-handler function is invoked with +** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument. +** This includes the case where the UPDATE operation is attempted after +** an earlier call to the conflict handler function returned +** [SQLITE_CHANGESET_REPLACE]. +**
+** +** It is safe to execute SQL statements, including those that write to the +** table that the callback related to, from within the xConflict callback. +** This can be used to further customize the application's conflict +** resolution strategy. +** +** All changes made by these functions are enclosed in a savepoint transaction. +** If any other error (aside from a constraint failure when attempting to +** write to the target database) occurs, then the savepoint transaction is +** rolled back, restoring the target database to its original state, and an +** SQLite error code returned. +** +** If the output parameters (ppRebase) and (pnRebase) are non-NULL and +** the input is a changeset (not a patchset), then tdsqlite3changeset_apply_v2() +** may set (*ppRebase) to point to a "rebase" that may be used with the +** tdsqlite3_rebaser APIs buffer before returning. In this case (*pnRebase) +** is set to the size of the buffer in bytes. It is the responsibility of the +** caller to eventually free any such buffer using tdsqlite3_free(). The buffer +** is only allocated and populated if one or more conflicts were encountered +** while applying the patchset. See comments surrounding the tdsqlite3_rebaser +** APIs for further details. +** +** The behavior of tdsqlite3changeset_apply_v2() and its streaming equivalent +** may be modified by passing a combination of +** [SQLITE_CHANGESETAPPLY_NOSAVEPOINT | supported flags] as the 9th parameter. +** +** Note that the tdsqlite3changeset_apply_v2() API is still experimental +** and therefore subject to change. +*/ +int tdsqlite3changeset_apply( + tdsqlite3 *db, /* Apply change to "main" db of this handle */ + int nChangeset, /* Size of changeset in bytes */ + void *pChangeset, /* Changeset blob */ + int(*xFilter)( + void *pCtx, /* Copy of sixth arg to _apply() */ + const char *zTab /* Table name */ + ), + int(*xConflict)( + void *pCtx, /* Copy of sixth arg to _apply() */ + int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ + tdsqlite3_changeset_iter *p /* Handle describing change and conflict */ + ), + void *pCtx /* First argument passed to xConflict */ +); +int tdsqlite3changeset_apply_v2( + tdsqlite3 *db, /* Apply change to "main" db of this handle */ + int nChangeset, /* Size of changeset in bytes */ + void *pChangeset, /* Changeset blob */ + int(*xFilter)( + void *pCtx, /* Copy of sixth arg to _apply() */ + const char *zTab /* Table name */ + ), + int(*xConflict)( + void *pCtx, /* Copy of sixth arg to _apply() */ + int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ + tdsqlite3_changeset_iter *p /* Handle describing change and conflict */ + ), + void *pCtx, /* First argument passed to xConflict */ + void **ppRebase, int *pnRebase, /* OUT: Rebase data */ + int flags /* SESSION_CHANGESETAPPLY_* flags */ +); + +/* +** CAPI3REF: Flags for tdsqlite3changeset_apply_v2 +** +** The following flags may passed via the 9th parameter to +** [tdsqlite3changeset_apply_v2] and [tdsqlite3changeset_apply_v2_strm]: +** +**
+**
SQLITE_CHANGESETAPPLY_NOSAVEPOINT
+** Usually, the sessions module encloses all operations performed by +** a single call to apply_v2() or apply_v2_strm() in a [SAVEPOINT]. The +** SAVEPOINT is committed if the changeset or patchset is successfully +** applied, or rolled back if an error occurs. Specifying this flag +** causes the sessions module to omit this savepoint. In this case, if the +** caller has an open transaction or savepoint when apply_v2() is called, +** it may revert the partially applied changeset by rolling it back. +** +**
SQLITE_CHANGESETAPPLY_INVERT
+** Invert the changeset before applying it. This is equivalent to inverting +** a changeset using tdsqlite3changeset_invert() before applying it. It is +** an error to specify this flag with a patchset. +*/ +#define SQLITE_CHANGESETAPPLY_NOSAVEPOINT 0x0001 +#define SQLITE_CHANGESETAPPLY_INVERT 0x0002 + +/* +** CAPI3REF: Constants Passed To The Conflict Handler +** +** Values that may be passed as the second argument to a conflict-handler. +** +**
+**
SQLITE_CHANGESET_DATA
+** The conflict handler is invoked with CHANGESET_DATA as the second argument +** when processing a DELETE or UPDATE change if a row with the required +** PRIMARY KEY fields is present in the database, but one or more other +** (non primary-key) fields modified by the update do not contain the +** expected "before" values. +** +** The conflicting row, in this case, is the database row with the matching +** primary key. +** +**
SQLITE_CHANGESET_NOTFOUND
+** The conflict handler is invoked with CHANGESET_NOTFOUND as the second +** argument when processing a DELETE or UPDATE change if a row with the +** required PRIMARY KEY fields is not present in the database. +** +** There is no conflicting row in this case. The results of invoking the +** tdsqlite3changeset_conflict() API are undefined. +** +**
SQLITE_CHANGESET_CONFLICT
+** CHANGESET_CONFLICT is passed as the second argument to the conflict +** handler while processing an INSERT change if the operation would result +** in duplicate primary key values. +** +** The conflicting row in this case is the database row with the matching +** primary key. +** +**
SQLITE_CHANGESET_FOREIGN_KEY
+** If foreign key handling is enabled, and applying a changeset leaves the +** database in a state containing foreign key violations, the conflict +** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument +** exactly once before the changeset is committed. If the conflict handler +** returns CHANGESET_OMIT, the changes, including those that caused the +** foreign key constraint violation, are committed. Or, if it returns +** CHANGESET_ABORT, the changeset is rolled back. +** +** No current or conflicting row information is provided. The only function +** it is possible to call on the supplied tdsqlite3_changeset_iter handle +** is tdsqlite3changeset_fk_conflicts(). +** +**
SQLITE_CHANGESET_CONSTRAINT
+** If any other constraint violation occurs while applying a change (i.e. +** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is +** invoked with CHANGESET_CONSTRAINT as the second argument. +** +** There is no conflicting row in this case. The results of invoking the +** tdsqlite3changeset_conflict() API are undefined. +** +**
+*/ +#define SQLITE_CHANGESET_DATA 1 +#define SQLITE_CHANGESET_NOTFOUND 2 +#define SQLITE_CHANGESET_CONFLICT 3 +#define SQLITE_CHANGESET_CONSTRAINT 4 +#define SQLITE_CHANGESET_FOREIGN_KEY 5 + +/* +** CAPI3REF: Constants Returned By The Conflict Handler +** +** A conflict handler callback must return one of the following three values. +** +**
+**
SQLITE_CHANGESET_OMIT
+** If a conflict handler returns this value no special action is taken. The +** change that caused the conflict is not applied. The session module +** continues to the next change in the changeset. +** +**
SQLITE_CHANGESET_REPLACE
+** This value may only be returned if the second argument to the conflict +** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this +** is not the case, any changes applied so far are rolled back and the +** call to tdsqlite3changeset_apply() returns SQLITE_MISUSE. +** +** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict +** handler, then the conflicting row is either updated or deleted, depending +** on the type of change. +** +** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict +** handler, then the conflicting row is removed from the database and a +** second attempt to apply the change is made. If this second attempt fails, +** the original row is restored to the database before continuing. +** +**
SQLITE_CHANGESET_ABORT
+** If this value is returned, any changes applied so far are rolled back +** and the call to tdsqlite3changeset_apply() returns SQLITE_ABORT. +**
+*/ +#define SQLITE_CHANGESET_OMIT 0 +#define SQLITE_CHANGESET_REPLACE 1 +#define SQLITE_CHANGESET_ABORT 2 + +/* +** CAPI3REF: Rebasing changesets +** EXPERIMENTAL +** +** Suppose there is a site hosting a database in state S0. And that +** modifications are made that move that database to state S1 and a +** changeset recorded (the "local" changeset). Then, a changeset based +** on S0 is received from another site (the "remote" changeset) and +** applied to the database. The database is then in state +** (S1+"remote"), where the exact state depends on any conflict +** resolution decisions (OMIT or REPLACE) made while applying "remote". +** Rebasing a changeset is to update it to take those conflict +** resolution decisions into account, so that the same conflicts +** do not have to be resolved elsewhere in the network. +** +** For example, if both the local and remote changesets contain an +** INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)": +** +** local: INSERT INTO t1 VALUES(1, 'v1'); +** remote: INSERT INTO t1 VALUES(1, 'v2'); +** +** and the conflict resolution is REPLACE, then the INSERT change is +** removed from the local changeset (it was overridden). Or, if the +** conflict resolution was "OMIT", then the local changeset is modified +** to instead contain: +** +** UPDATE t1 SET b = 'v2' WHERE a=1; +** +** Changes within the local changeset are rebased as follows: +** +**
+**
Local INSERT
+** This may only conflict with a remote INSERT. If the conflict +** resolution was OMIT, then add an UPDATE change to the rebased +** changeset. Or, if the conflict resolution was REPLACE, add +** nothing to the rebased changeset. +** +**
Local DELETE
+** This may conflict with a remote UPDATE or DELETE. In both cases the +** only possible resolution is OMIT. If the remote operation was a +** DELETE, then add no change to the rebased changeset. If the remote +** operation was an UPDATE, then the old.* fields of change are updated +** to reflect the new.* values in the UPDATE. +** +**
Local UPDATE
+** This may conflict with a remote UPDATE or DELETE. If it conflicts +** with a DELETE, and the conflict resolution was OMIT, then the update +** is changed into an INSERT. Any undefined values in the new.* record +** from the update change are filled in using the old.* values from +** the conflicting DELETE. Or, if the conflict resolution was REPLACE, +** the UPDATE change is simply omitted from the rebased changeset. +** +** If conflict is with a remote UPDATE and the resolution is OMIT, then +** the old.* values are rebased using the new.* values in the remote +** change. Or, if the resolution is REPLACE, then the change is copied +** into the rebased changeset with updates to columns also updated by +** the conflicting remote UPDATE removed. If this means no columns would +** be updated, the change is omitted. +**
+** +** A local change may be rebased against multiple remote changes +** simultaneously. If a single key is modified by multiple remote +** changesets, they are combined as follows before the local changeset +** is rebased: +** +**
    +**
  • If there has been one or more REPLACE resolutions on a +** key, it is rebased according to a REPLACE. +** +**
  • If there have been no REPLACE resolutions on a key, then +** the local changeset is rebased according to the most recent +** of the OMIT resolutions. +**
+** +** Note that conflict resolutions from multiple remote changesets are +** combined on a per-field basis, not per-row. This means that in the +** case of multiple remote UPDATE operations, some fields of a single +** local change may be rebased for REPLACE while others are rebased for +** OMIT. +** +** In order to rebase a local changeset, the remote changeset must first +** be applied to the local database using tdsqlite3changeset_apply_v2() and +** the buffer of rebase information captured. Then: +** +**
    +**
  1. An tdsqlite3_rebaser object is created by calling +** tdsqlite3rebaser_create(). +**
  2. The new object is configured with the rebase buffer obtained from +** tdsqlite3changeset_apply_v2() by calling tdsqlite3rebaser_configure(). +** If the local changeset is to be rebased against multiple remote +** changesets, then tdsqlite3rebaser_configure() should be called +** multiple times, in the same order that the multiple +** tdsqlite3changeset_apply_v2() calls were made. +**
  3. Each local changeset is rebased by calling tdsqlite3rebaser_rebase(). +**
  4. The tdsqlite3_rebaser object is deleted by calling +** tdsqlite3rebaser_delete(). +**
+*/ +typedef struct tdsqlite3_rebaser tdsqlite3_rebaser; + +/* +** CAPI3REF: Create a changeset rebaser object. +** EXPERIMENTAL +** +** Allocate a new changeset rebaser object. If successful, set (*ppNew) to +** point to the new object and return SQLITE_OK. Otherwise, if an error +** occurs, return an SQLite error code (e.g. SQLITE_NOMEM) and set (*ppNew) +** to NULL. +*/ +int tdsqlite3rebaser_create(tdsqlite3_rebaser **ppNew); + +/* +** CAPI3REF: Configure a changeset rebaser object. +** EXPERIMENTAL +** +** Configure the changeset rebaser object to rebase changesets according +** to the conflict resolutions described by buffer pRebase (size nRebase +** bytes), which must have been obtained from a previous call to +** tdsqlite3changeset_apply_v2(). +*/ +int tdsqlite3rebaser_configure( + tdsqlite3_rebaser*, + int nRebase, const void *pRebase +); + +/* +** CAPI3REF: Rebase a changeset +** EXPERIMENTAL +** +** Argument pIn must point to a buffer containing a changeset nIn bytes +** in size. This function allocates and populates a buffer with a copy +** of the changeset rebased according to the configuration of the +** rebaser object passed as the first argument. If successful, (*ppOut) +** is set to point to the new buffer containing the rebased changeset and +** (*pnOut) to its size in bytes and SQLITE_OK returned. It is the +** responsibility of the caller to eventually free the new buffer using +** tdsqlite3_free(). Otherwise, if an error occurs, (*ppOut) and (*pnOut) +** are set to zero and an SQLite error code returned. +*/ +int tdsqlite3rebaser_rebase( + tdsqlite3_rebaser*, + int nIn, const void *pIn, + int *pnOut, void **ppOut +); + +/* +** CAPI3REF: Delete a changeset rebaser object. +** EXPERIMENTAL +** +** Delete the changeset rebaser object and all associated resources. There +** should be one call to this function for each successful invocation +** of tdsqlite3rebaser_create(). +*/ +void tdsqlite3rebaser_delete(tdsqlite3_rebaser *p); + +/* +** CAPI3REF: Streaming Versions of API functions. +** +** The six streaming API xxx_strm() functions serve similar purposes to the +** corresponding non-streaming API functions: +** +** +** +**
Streaming functionNon-streaming equivalent
tdsqlite3changeset_apply_strm[tdsqlite3changeset_apply] +**
tdsqlite3changeset_apply_strm_v2[tdsqlite3changeset_apply_v2] +**
tdsqlite3changeset_concat_strm[tdsqlite3changeset_concat] +**
tdsqlite3changeset_invert_strm[tdsqlite3changeset_invert] +**
tdsqlite3changeset_start_strm[tdsqlite3changeset_start] +**
tdsqlite3session_changeset_strm[tdsqlite3session_changeset] +**
tdsqlite3session_patchset_strm[tdsqlite3session_patchset] +**
+** +** Non-streaming functions that accept changesets (or patchsets) as input +** require that the entire changeset be stored in a single buffer in memory. +** Similarly, those that return a changeset or patchset do so by returning +** a pointer to a single large buffer allocated using tdsqlite3_malloc(). +** Normally this is convenient. However, if an application running in a +** low-memory environment is required to handle very large changesets, the +** large contiguous memory allocations required can become onerous. +** +** In order to avoid this problem, instead of a single large buffer, input +** is passed to a streaming API functions by way of a callback function that +** the sessions module invokes to incrementally request input data as it is +** required. In all cases, a pair of API function parameters such as +** +** 
+**        int nChangeset,
+**        void *pChangeset,
+**
+** +** Is replaced by: +** +** 
+**        int (*xInput)(void *pIn, void *pData, int *pnData),
+**        void *pIn,
+**
+** +** Each time the xInput callback is invoked by the sessions module, the first +** argument passed is a copy of the supplied pIn context pointer. The second +** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no +** error occurs the xInput method should copy up to (*pnData) bytes of data +** into the buffer and set (*pnData) to the actual number of bytes copied +** before returning SQLITE_OK. If the input is completely exhausted, (*pnData) +** should be set to zero to indicate this. Or, if an error occurs, an SQLite +** error code should be returned. In all cases, if an xInput callback returns +** an error, all processing is abandoned and the streaming API function +** returns a copy of the error code to the caller. +** +** In the case of tdsqlite3changeset_start_strm(), the xInput callback may be +** invoked by the sessions module at any point during the lifetime of the +** iterator. If such an xInput callback returns an error, the iterator enters +** an error state, whereby all subsequent calls to iterator functions +** immediately fail with the same error code as returned by xInput. +** +** Similarly, streaming API functions that return changesets (or patchsets) +** return them in chunks by way of a callback function instead of via a +** pointer to a single large buffer. In this case, a pair of parameters such +** as: +** +** 
+**        int *pnChangeset,
+**        void **ppChangeset,
+**
+** +** Is replaced by: +** +** 
+**        int (*xOutput)(void *pOut, const void *pData, int nData),
+**        void *pOut
+**
+** +** The xOutput callback is invoked zero or more times to return data to +** the application. The first parameter passed to each call is a copy of the +** pOut pointer supplied by the application. The second parameter, pData, +** points to a buffer nData bytes in size containing the chunk of output +** data being returned. If the xOutput callback successfully processes the +** supplied data, it should return SQLITE_OK to indicate success. Otherwise, +** it should return some other SQLite error code. In this case processing +** is immediately abandoned and the streaming API function returns a copy +** of the xOutput error code to the application. +** +** The sessions module never invokes an xOutput callback with the third +** parameter set to a value less than or equal to zero. Other than this, +** no guarantees are made as to the size of the chunks of data returned. +*/ +int tdsqlite3changeset_apply_strm( + tdsqlite3 *db, /* Apply change to "main" db of this handle */ + int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */ + void *pIn, /* First arg for xInput */ + int(*xFilter)( + void *pCtx, /* Copy of sixth arg to _apply() */ + const char *zTab /* Table name */ + ), + int(*xConflict)( + void *pCtx, /* Copy of sixth arg to _apply() */ + int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ + tdsqlite3_changeset_iter *p /* Handle describing change and conflict */ + ), + void *pCtx /* First argument passed to xConflict */ +); +int tdsqlite3changeset_apply_v2_strm( + tdsqlite3 *db, /* Apply change to "main" db of this handle */ + int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */ + void *pIn, /* First arg for xInput */ + int(*xFilter)( + void *pCtx, /* Copy of sixth arg to _apply() */ + const char *zTab /* Table name */ + ), + int(*xConflict)( + void *pCtx, /* Copy of sixth arg to _apply() */ + int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */ + tdsqlite3_changeset_iter *p /* Handle describing change and conflict */ + ), + void *pCtx, /* First argument passed to xConflict */ + void **ppRebase, int *pnRebase, + int flags +); +int tdsqlite3changeset_concat_strm( + int (*xInputA)(void *pIn, void *pData, int *pnData), + void *pInA, + int (*xInputB)(void *pIn, void *pData, int *pnData), + void *pInB, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +int tdsqlite3changeset_invert_strm( + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +int tdsqlite3changeset_start_strm( + tdsqlite3_changeset_iter **pp, + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn +); +int tdsqlite3changeset_start_v2_strm( + tdsqlite3_changeset_iter **pp, + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn, + int flags +); +int tdsqlite3session_changeset_strm( + tdsqlite3_session *pSession, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +int tdsqlite3session_patchset_strm( + tdsqlite3_session *pSession, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +int tdsqlite3changegroup_add_strm(tdsqlite3_changegroup*, + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn +); +int tdsqlite3changegroup_output_strm(tdsqlite3_changegroup*, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); +int tdsqlite3rebaser_rebase_strm( + tdsqlite3_rebaser *pRebaser, + int (*xInput)(void *pIn, void *pData, int *pnData), + void *pIn, + int (*xOutput)(void *pOut, const void *pData, int nData), + void *pOut +); + +/* +** CAPI3REF: Configure global parameters +** +** The tdsqlite3session_config() interface is used to make global configuration +** changes to the sessions module in order to tune it to the specific needs +** of the application. +** +** The tdsqlite3session_config() interface is not threadsafe. If it is invoked +** while any other thread is inside any other sessions method then the +** results are undefined. Furthermore, if it is invoked after any sessions +** related objects have been created, the results are also undefined. +** +** The first argument to the tdsqlite3session_config() function must be one +** of the SQLITE_SESSION_CONFIG_XXX constants defined below. The +** interpretation of the (void*) value passed as the second parameter and +** the effect of calling this function depends on the value of the first +** parameter. +** +**
+**
SQLITE_SESSION_CONFIG_STRMSIZE
+** By default, the sessions module streaming interfaces attempt to input +** and output data in approximately 1 KiB chunks. This operand may be used +** to set and query the value of this configuration setting. The pointer +** passed as the second argument must point to a value of type (int). +** If this value is greater than 0, it is used as the new streaming data +** chunk size for both input and output. Before returning, the (int) value +** pointed to by pArg is set to the final value of the streaming interface +** chunk size. +**
+** +** This function returns SQLITE_OK if successful, or an SQLite error code +** otherwise. +*/ +int tdsqlite3session_config(int op, void *pArg); + +/* +** CAPI3REF: Values for tdsqlite3session_config(). +*/ +#define SQLITE_SESSION_CONFIG_STRMSIZE 1 + +/* +** Make sure we can call this stuff from C++. +*/ +#ifdef __cplusplus +} +#endif + +#endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */ diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/crc32.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/crc32.h new file mode 100644 index 0000000000..b461784b31 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/crc32.h @@ -0,0 +1,37 @@ +/* + This file is part of VK/KittenPHP-DB-Engine Library. + + VK/KittenPHP-DB-Engine Library is free software: you can redistribute it and/or modify + it under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation, either version 2 of the License, or + (at your option) any later version. + + VK/KittenPHP-DB-Engine Library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public License + along with VK/KittenPHP-DB-Engine Library. If not, see . + + Copyright 2009-2012 Vkontakte Ltd + 2009-2012 Nikolai Durov + 2009-2012 Andrei Lopatin + 2012 Anton Maydell +*/ + +#ifndef __CRC32_H__ +#define __CRC32_H__ + + +#ifdef __cplusplus +extern "C" { +#endif + +unsigned int compute_crc32 (const void *data, int len); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/portable_endian.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/portable_endian.h new file mode 100644 index 0000000000..a815547e39 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/portable_endian.h @@ -0,0 +1,88 @@ +// "License": Public Domain +// I, Mathias Panzenböck, place this file hereby into the public domain. Use it at your own risk for whatever you like. +// In case there are jurisdictions that don't support putting things in the public domain you can also consider it to +// be "dual licensed" under the BSD, MIT and Apache licenses, if you want to. This code is trivial anyway. Consider it +// an example on how to get the endian conversion functions on different platforms. + +/* Originally cloned from https://gist.github.com/PkmX/63dd23f28ba885be53a5 + * Commit was: 1eca2ab34f2301b9641aa73d1016b951fff3fc39 + * Re-published at https://github.com/BenWiederhake/portable-endian.h to provide a means to submit patches and report issues. */ + +#ifndef PORTABLE_ENDIAN_H__ +#define PORTABLE_ENDIAN_H__ + +#if (defined(_WIN16) || defined(_WIN32) || defined(_WIN64)) && !defined(__WINDOWS__) + +# define __WINDOWS__ + +#endif + +#if defined(__linux__) || defined(__CYGWIN__) || defined(__sun) + +# include + +#elif defined(__APPLE__) + +# include + +# define htobe32(x) OSSwapHostToBigInt32(x) +# define htole32(x) OSSwapHostToLittleInt32(x) + +# define htobe64(x) OSSwapHostToBigInt64(x) +# define htole64(x) OSSwapHostToLittleInt64(x) + +# define __BYTE_ORDER BYTE_ORDER +# define __BIG_ENDIAN BIG_ENDIAN +# define __LITTLE_ENDIAN LITTLE_ENDIAN +# define __PDP_ENDIAN PDP_ENDIAN + +#elif defined(__OpenBSD__) + +# include + +#elif defined(__NetBSD__) || defined(__FreeBSD__) || defined(__DragonFly__) + +# include + +#elif defined(__WINDOWS__) + +# include +#ifdef __MINGW32__ +# include +#endif + +# if BYTE_ORDER == LITTLE_ENDIAN + +# define htobe32(x) htonl(x) +# define htole32(x) (x) + +# define htobe64(x) htonll(x) +# define htole64(x) (x) + +# elif BYTE_ORDER == BIG_ENDIAN + + /* that would be xbox 360 */ +# define htobe32(x) (x) +# define htole32(x) __builtin_bswap32(x) + +# define htobe64(x) (x) +# define htole64(x) __builtin_bswap64(x) + +# else + +# error byte order not supported + +# endif + +# define __BYTE_ORDER BYTE_ORDER +# define __BIG_ENDIAN BIG_ENDIAN +# define __LITTLE_ENDIAN LITTLE_ENDIAN +# define __PDP_ENDIAN PDP_ENDIAN + +#else + +# error platform not supported + +#endif + +#endif diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-parser-tree.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-parser-tree.h new file mode 100644 index 0000000000..fba7c67521 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-parser-tree.h @@ -0,0 +1,178 @@ +/* + This file is part of tgl-library + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + + Copyright Vitaly Valtman 2013-2014 +*/ +#ifndef __TREE_H__ +#define __TREE_H__ +#include + +#include +#include + +#pragma pack(push,4) +#define DEFINE_TREE(X_NAME, X_TYPE, X_CMP, X_UNSET) \ +struct tree_ ## X_NAME { \ + struct tree_ ## X_NAME *left, *right;\ + X_TYPE x;\ + int y;\ +};\ +\ +static struct tree_ ## X_NAME *new_tree_node_ ## X_NAME (X_TYPE x, int y) {\ + struct tree_ ## X_NAME *T = malloc (sizeof (*T));\ + T->x = x;\ + T->y = y;\ + T->left = T->right = 0;\ + return T;\ +}\ +\ +static void delete_tree_node_ ## X_NAME (struct tree_ ## X_NAME *T) {\ + free (T);\ +}\ +\ +static void tree_split_ ## X_NAME (struct tree_ ## X_NAME *T, X_TYPE x, struct tree_ ## X_NAME **L, struct tree_ ## X_NAME **R) {\ + if (!T) {\ + *L = *R = 0;\ + } else {\ + int c = X_CMP (x, T->x);\ + if (c < 0) {\ + tree_split_ ## X_NAME (T->left, x, L, &T->left);\ + *R = T;\ + } else {\ + tree_split_ ## X_NAME (T->right, x, &T->right, R);\ + *L = T;\ + }\ + }\ +}\ +\ +static struct tree_ ## X_NAME *tree_insert_ ## X_NAME (struct tree_ ## X_NAME *T, X_TYPE x, int y) __attribute__ ((warn_unused_result,unused));\ +static struct tree_ ## X_NAME *tree_insert_ ## X_NAME (struct tree_ ## X_NAME *T, X_TYPE x, int y) {\ + if (!T) {\ + return new_tree_node_ ## X_NAME (x, y);\ + } else {\ + if (y > T->y) {\ + struct tree_ ## X_NAME *N = new_tree_node_ ## X_NAME (x, y);\ + tree_split_ ## X_NAME (T, x, &N->left, &N->right);\ + return N;\ + } else {\ + int c = X_CMP (x, T->x);\ + assert (c);\ + if (c < 0) { \ + T->left = tree_insert_ ## X_NAME (T->left, x, y);\ + } else { \ + T->right = tree_insert_ ## X_NAME (T->right, x, y);\ + } \ + return T; \ + }\ + }\ +}\ +\ +static struct tree_ ## X_NAME *tree_merge_ ## X_NAME (struct tree_ ## X_NAME *L, struct tree_ ## X_NAME *R) {\ + if (!L || !R) {\ + return L ? L : R;\ + } else {\ + if (L->y > R->y) {\ + L->right = tree_merge_ ## X_NAME (L->right, R);\ + return L;\ + } else {\ + R->left = tree_merge_ ## X_NAME (L, R->left);\ + return R;\ + }\ + }\ +}\ +\ +static struct tree_ ## X_NAME *tree_delete_ ## X_NAME (struct tree_ ## X_NAME *T, X_TYPE x) __attribute__ ((warn_unused_result,unused));\ +static struct tree_ ## X_NAME *tree_delete_ ## X_NAME (struct tree_ ## X_NAME *T, X_TYPE x) {\ + assert (T);\ + int c = X_CMP (x, T->x);\ + if (!c) {\ + struct tree_ ## X_NAME *N = tree_merge_ ## X_NAME (T->left, T->right);\ + delete_tree_node_ ## X_NAME (T);\ + return N;\ + } else {\ + if (c < 0) { \ + T->left = tree_delete_ ## X_NAME (T->left, x); \ + } else { \ + T->right = tree_delete_ ## X_NAME (T->right, x); \ + } \ + return T; \ + }\ +}\ +\ +static X_TYPE tree_get_min_ ## X_NAME (struct tree_ ## X_NAME *t) __attribute__ ((unused));\ +static X_TYPE tree_get_min_ ## X_NAME (struct tree_ ## X_NAME *T) {\ + if (!T) { return X_UNSET; } \ + while (T->left) { T = T->left; }\ + return T->x; \ +} \ +\ +static X_TYPE tree_lookup_ ## X_NAME (struct tree_ ## X_NAME *T, X_TYPE x) __attribute__ ((unused));\ +static X_TYPE tree_lookup_ ## X_NAME (struct tree_ ## X_NAME *T, X_TYPE x) {\ + int c;\ + while (T && (c = X_CMP (x, T->x))) {\ + T = (c < 0 ? T->left : T->right);\ + }\ + return T ? T->x : X_UNSET;\ +}\ +\ +static void tree_act_ ## X_NAME (struct tree_ ## X_NAME *T, void (*act)(X_TYPE)) __attribute__ ((unused));\ +static void tree_act_ ## X_NAME (struct tree_ ## X_NAME *T, void (*act)(X_TYPE)) {\ + if (!T) { return; } \ + tree_act_ ## X_NAME (T->left, act); \ + act (T->x); \ + tree_act_ ## X_NAME (T->right, act); \ +}\ +\ +static void tree_act_ex_ ## X_NAME (struct tree_ ## X_NAME *T, void (*act)(X_TYPE, void *), void *extra) __attribute__ ((unused));\ +static void tree_act_ex_ ## X_NAME (struct tree_ ## X_NAME *T, void (*act)(X_TYPE, void *), void *extra) {\ + if (!T) { return; } \ + tree_act_ex_ ## X_NAME (T->left, act, extra); \ + act (T->x, extra); \ + tree_act_ex_ ## X_NAME (T->right, act, extra); \ +}\ +\ +static int tree_count_ ## X_NAME (struct tree_ ## X_NAME *T) __attribute__ ((unused));\ +static int tree_count_ ## X_NAME (struct tree_ ## X_NAME *T) { \ + if (!T) { return 0; }\ + return 1 + tree_count_ ## X_NAME (T->left) + tree_count_ ## X_NAME (T->right); \ +}\ +static void tree_check_ ## X_NAME (struct tree_ ## X_NAME *T) __attribute__ ((unused));\ +static void tree_check_ ## X_NAME (struct tree_ ## X_NAME *T) { \ + if (!T) { return; }\ + if (T->left) { \ + assert (T->left->y <= T->y);\ + assert (X_CMP (T->left->x, T->x) < 0); \ + }\ + if (T->right) { \ + assert (T->right->y <= T->y);\ + assert (X_CMP (T->right->x, T->x) > 0); \ + }\ + tree_check_ ## X_NAME (T->left); \ + tree_check_ ## X_NAME (T->right); \ +}\ +static struct tree_ ## X_NAME *tree_clear_ ## X_NAME (struct tree_ ## X_NAME *T) __attribute__ ((unused));\ +static struct tree_ ## X_NAME *tree_clear_ ## X_NAME (struct tree_ ## X_NAME *T) { \ + if (!T) { return 0; }\ + tree_clear_ ## X_NAME (T->left); \ + tree_clear_ ## X_NAME (T->right); \ + delete_tree_node_ ## X_NAME (T); \ + return 0; \ +} \ + +#define int_cmp(a,b) ((a) - (b)) +#pragma pack(pop) +#endif diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-parser.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-parser.h new file mode 100644 index 0000000000..59209d4a55 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-parser.h @@ -0,0 +1,223 @@ +/* + This file is part of tgl-libary/tlc + + Tgl-library/tlc is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 2 of the License, or + (at your option) any later version. + + Tgl-library/tlc is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this tgl-library/tlc. If not, see . + + Copyright Vitaly Valtman 2014 + + It is derivative work of VK/KittenPHP-DB-Engine (https://github.com/vk-com/kphp-kdb/) + Copyright 2012-2013 Vkontakte Ltd + 2012-2013 Vitaliy Valtman + +*/ + +#ifndef __TL_PARSER_NEW_H__ +#define __TL_PARSER_NEW_H__ + +#include + +enum lex_type { + lex_error, + lex_char, + lex_triple_minus, + lex_uc_ident, + lex_lc_ident, + lex_eof, + lex_final, + lex_new, + lex_none, + lex_num, + lex_empty +}; + + +struct curlex { + char *ptr; + int len; + enum lex_type type; + int flags; +}; + +struct parse { + char *text; + int pos; + int len; + int line; + int line_pos; + struct curlex lex; +}; + + +enum tree_type { + type_tl_program, + type_fun_declarations, + type_constr_declarations, + type_declaration, + type_combinator_decl, + type_equals, + type_partial_app_decl, + type_final_decl, + type_full_combinator_id, + type_opt_args, + type_args, + type_args1, + type_args2, + type_args3, + type_args4, + type_boxed_type_ident, + type_subexpr, + type_partial_comb_app_decl, + type_partial_type_app_decl, + type_final_new, + type_final_final, + type_final_empty, +// type_type, + type_var_ident, + type_var_ident_opt, + type_multiplicity, + type_type_term, + type_term, + type_percent, + type_result_type, + type_expr, + type_nat_term, + type_combinator_id, + type_nat_const, + type_type_ident, + type_builtin_combinator_decl, + type_exclam, + type_optional_arg_def +}; + +struct tree { + char *text; + int len; + enum tree_type type; + int lex_line; + int lex_line_pos; + int flags; + int size; + int nc; + struct tree **c; +}; + + +#define TL_ACT(x) (x == act_var ? "act_var" : x == act_field ? "act_field" : x == act_plus ? "act_plus" : x == act_type ? "act_type" : x == act_nat_const ? "act_nat_const" : x == act_array ? "act_array" : x == act_question_mark ? "act_question_mark" : \ + x == act_union ? "act_union" : x == act_arg ? "act_arg" : x == act_opt_field ? "act_opt_field" : "act_unknown") + +#define TL_TYPE(x) (x == type_num ? "type_num" : x == type_type ? "type_type" : x == type_list_item ? "type_list_item" : x == type_list ? "type_list" : x == type_num_value ? "type_num_value" : "type_unknown") +enum combinator_tree_action { + act_var, + act_field, + act_plus, + act_type, + act_nat_const, + act_array, + act_question_mark, + act_union, + act_arg, + act_opt_field +}; + +enum combinator_tree_type { + type_num, + type_num_value, + type_type, + type_list_item, + type_list +}; + +struct tl_combinator_tree { + enum combinator_tree_action act; + struct tl_combinator_tree *left, *right; + char *name; + void *data; + long long flags; + enum combinator_tree_type type; + int type_len; + long long type_flags; +}; + + +struct tl_program { + int types_num; + int functions_num; + int constructors_num; + struct tl_type **types; + struct tl_function **functions; +// struct tl_constuctor **constructors; +}; + +struct tl_type { + char *id; + char *print_id; + char *real_id; + unsigned name; + int flags; + + int params_num; + long long params_types; + + int constructors_num; + struct tl_constructor **constructors; +}; + +struct tl_constructor { + char *id; + char *print_id; + char *real_id; + unsigned name; + struct tl_type *type; + + struct tl_combinator_tree *left; + struct tl_combinator_tree *right; +}; + +struct tl_var { + char *id; + struct tl_combinator_tree *ptr; + int type; + int flags; +}; + +struct parse *tl_init_parse_file (const char *fname); +struct tree *tl_parse_lex (struct parse *P); +void tl_print_parse_error (void); +struct tl_program *tl_parse (struct tree *T); + +void write_types (FILE *f); + +#define FLAG_BARE 1 +#define FLAG_OPT_VAR (1 << 17) +#define FLAG_EXCL (1 << 18) +#define FLAG_OPT_FIELD (1 << 20) +#define FLAG_IS_VAR (1 << 21) +#define FLAG_DEFAULT_CONSTRUCTOR (1 << 25) +#define FLAG_EMPTY (1 << 10) + +#ifdef NDEBUG +#undef assert +#define assert(x) if (!(x)) { fprintf(stderr, "Assertion error!\n"); abort(); } +#endif + +#ifdef _WIN32 +#include "wgetopt.h" + +#define __attribute__(x) + +#define lrand48() rand() +#define strdup _strdup +#endif + +#endif diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-tl.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-tl.h new file mode 100644 index 0000000000..8bc0a707bc --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/tl-tl.h @@ -0,0 +1,55 @@ +/* + This file is part of VK/KittenPHP-DB-Engine. + + VK/KittenPHP-DB-Engine is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 2 of the License, or + (at your option) any later version. + + VK/KittenPHP-DB-Engine is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with VK/KittenPHP-DB-Engine. If not, see . + + This program is released under the GPL with the additional exemption + that compiling, linking, and/or using OpenSSL is allowed. + You are free to remove this exemption from derived works. + + Copyright 2012-2013 Vkontakte Ltd + 2012-2013 Vitaliy Valtman +*/ + +#ifndef __TL_TL_H__ +#define __TL_TL_H__ + +// Current tl-tl schema is V2 +// See https://core.telegram.org/mtproto/TL-tl + +#define TLS_SCHEMA_V2 0x3a2f9be2 +#define TLS_TYPE 0x12eb4386 +#define TLS_COMBINATOR 0x5c0a1ed5 +#define TLS_COMBINATOR_LEFT_BUILTIN 0xcd211f63 +#define TLS_COMBINATOR_LEFT 0x4c12c6d9 +#define TLS_COMBINATOR_RIGHT_V2 0x2c064372 +#define TLS_ARG_V2 0x29dfe61b + +#define TLS_EXPR_TYPE 0xecc9da78 +#define TLS_EXPR_NAT 0xdcb49bd8 + +#define TLS_NAT_CONST 0xdcb49bd8 +#define TLS_NAT_VAR 0x4e8a14f0 +#define TLS_TYPE_VAR 0x0142ceae +#define TLS_ARRAY 0xd9fb20de +#define TLS_TYPE_EXPR 0xc1863d08 + +/* Deprecated (old versions), read-only */ +#define TLS_TREE_NAT_CONST 0xc09f07d7 +#define TLS_TREE_NAT_VAR 0x90ea6f58 +#define TLS_TREE_TYPE_VAR 0x1caa237a +#define TLS_TREE_ARRAY 0x80479360 +#define TLS_TREE_TYPE 0x10f32190 + +#endif diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/wgetopt.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/wgetopt.h new file mode 100644 index 0000000000..6e2fa27180 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl-parser/wgetopt.h @@ -0,0 +1,193 @@ +/* Declarations for getopt. + Copyright (C) 1989-1994,1996-1999,2001,2003,2004,2009,2010 + Free Software Foundation, Inc. + This file is part of the GNU C Library. + + The GNU C Library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + The GNU C Library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with the GNU C Library; if not, write to the Free + Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA + 02111-1307 USA. */ + +#ifndef _GETOPT_H + +#ifndef __need_getopt +# define _GETOPT_H 1 +#endif + +/* If __GNU_LIBRARY__ is not already defined, either we are being used + standalone, or this is the first header included in the source file. + If we are being used with glibc, we need to include , but + that does not exist if we are standalone. So: if __GNU_LIBRARY__ is + not defined, include , which will pull in for us + if it's from glibc. (Why ctype.h? It's guaranteed to exist and it + doesn't flood the namespace with stuff the way some other headers do.) */ +#if !defined __GNU_LIBRARY__ +# include +#endif + +#ifndef __THROW +# ifndef __GNUC_PREREQ +# define __GNUC_PREREQ(maj, min) (0) +# endif +# if defined __cplusplus && __GNUC_PREREQ (2,8) +# define __THROW throw () +# else +# define __THROW +# endif +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/* For communication from `getopt' to the caller. + When `getopt' finds an option that takes an argument, + the argument value is returned here. + Also, when `ordering' is RETURN_IN_ORDER, + each non-option ARGV-element is returned here. */ + +extern char *optarg; + +/* Index in ARGV of the next element to be scanned. + This is used for communication to and from the caller + and for communication between successive calls to `getopt'. + + On entry to `getopt', zero means this is the first call; initialize. + + When `getopt' returns -1, this is the index of the first of the + non-option elements that the caller should itself scan. + + Otherwise, `optind' communicates from one call to the next + how much of ARGV has been scanned so far. */ + +extern int optind; + +/* Callers store zero here to inhibit the error message `getopt' prints + for unrecognized options. */ + +extern int opterr; + +/* Set to an option character which was unrecognized. */ + +extern int optopt; + +#ifndef __need_getopt +/* Describe the long-named options requested by the application. + The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector + of `struct option' terminated by an element containing a name which is + zero. + + The field `has_arg' is: + no_argument (or 0) if the option does not take an argument, + required_argument (or 1) if the option requires an argument, + optional_argument (or 2) if the option takes an optional argument. + + If the field `flag' is not NULL, it points to a variable that is set + to the value given in the field `val' when the option is found, but + left unchanged if the option is not found. + + To have a long-named option do something other than set an `int' to + a compiled-in constant, such as set a value from `optarg', set the + option's `flag' field to zero and its `val' field to a nonzero + value (the equivalent single-letter option character, if there is + one). For long options that have a zero `flag' field, `getopt' + returns the contents of the `val' field. */ + +struct option +{ + const char *name; + /* has_arg can't be an enum because some compilers complain about + type mismatches in all the code that assumes it is an int. */ + int has_arg; + int *flag; + int val; +}; + +/* Names for the values of the `has_arg' field of `struct option'. */ + +# define no_argument 0 +# define required_argument 1 +# define optional_argument 2 +#endif /* need getopt */ + + +/* Get definitions and prototypes for functions to process the + arguments in ARGV (ARGC of them, minus the program name) for + options given in OPTS. + + Return the option character from OPTS just read. Return -1 when + there are no more options. For unrecognized options, or options + missing arguments, `optopt' is set to the option letter, and '?' is + returned. + + The OPTS string is a list of characters which are recognized option + letters, optionally followed by colons, specifying that that letter + takes an argument, to be placed in `optarg'. + + If a letter in OPTS is followed by two colons, its argument is + optional. This behavior is specific to the GNU `getopt'. + + The argument `--' causes premature termination of argument + scanning, explicitly telling `getopt' that there are no more + options. + + If OPTS begins with `--', then non-option arguments are treated as + arguments to the option '\0'. This behavior is specific to the GNU + `getopt'. */ + +#ifdef __GNU_LIBRARY__ +/* Many other libraries have conflicting prototypes for getopt, with + differences in the consts, in stdlib.h. To avoid compilation + errors, only prototype getopt for the GNU C library. */ +extern int getopt (int ___argc, char *const *___argv, const char *__shortopts) + __THROW; + +# if defined __need_getopt && defined __USE_POSIX2 \ + && !defined __USE_POSIX_IMPLICITLY && !defined __USE_GNU +/* The GNU getopt has more functionality than the standard version. The + additional functionality can be disable at runtime. This redirection + helps to also do this at runtime. */ +# ifdef __REDIRECT + extern int __REDIRECT_NTH (getopt, (int ___argc, char *const *___argv, + const char *__shortopts), + __posix_getopt); +# else +extern int __posix_getopt (int ___argc, char *const *___argv, + const char *__shortopts) __THROW; +# define getopt __posix_getopt +# endif +# endif +#else /* not __GNU_LIBRARY__ */ +extern int getopt (); +#endif /* __GNU_LIBRARY__ */ + +#ifndef __need_getopt +extern int getopt_long (int ___argc, char *const *___argv, + const char *__shortopts, + const struct option *__longopts, int *__longind) + __THROW; +extern int getopt_long_only (int ___argc, char *const *___argv, + const char *__shortopts, + const struct option *__longopts, int *__longind) + __THROW; + +#endif + +#ifdef __cplusplus +} +#endif + +/* Make sure we later can get all the definitions and declarations. */ +#undef __need_getopt + +#endif /* getopt.h */ diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_json_converter.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_json_converter.h new file mode 100644 index 0000000000..3f9ec7df9d --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_json_converter.h @@ -0,0 +1,18 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/tl/tl_config.h" +#include "td/tl/tl_writer.h" + +#include + +namespace td { + +void gen_json_converter(const tl::tl_config &config, const std::string &file_name, tl::TL_writer::Mode mode); + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_c.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_c.h new file mode 100644 index 0000000000..4c288e6103 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_c.h @@ -0,0 +1,1378 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/tl/tl_writer.h" + +#include +#include +#include +#include +#include + +namespace td { + +class TlWriterCCommon final : public tl::TL_writer { + int is_header_; + + public: + TlWriterCCommon(const std::string &name, int is_header) : TL_writer(name), is_header_(is_header) { + } + + int get_max_arity() const final { + return 0; + } + + bool is_built_in_simple_type(const std::string &name) const final { + return name == "Bool" || name == "Int32" || name == "Int53" || name == "Int64" || name == "Double" || + name == "String" || name == "Bytes"; + } + bool is_built_in_complex_type(const std::string &name) const final { + return name == "Vector"; + } + bool is_type_bare(const tl::tl_type *t) const final { + return t->simple_constructors <= 1 || (is_built_in_simple_type(t->name) && t->name != "Bool") || + is_built_in_complex_type(t->name); + } + + std::vector get_parsers() const final { + return {}; + } + int get_parser_type(const tl::tl_combinator *t, const std::string &name) const final { + return 0; + } + std::vector get_storers() const final { + return {}; + } + std::vector get_additional_functions() const final { + return {"TdConvertToInternal", "TdConvertFromInternal", "TdSerialize", "TdToString", + "TdDestroyObject", "TdStackStorer", "TdStackFetcher", "enum"}; + } + int get_storer_type(const tl::tl_combinator *t, const std::string &name) const final { + return name == "to_string" || name == "to_cpp_string"; + } + + std::string gen_base_tl_class_name() const final { + return "Object"; + } + std::string gen_base_type_class_name(int arity) const final { + assert(arity == 0); + return "Object"; + } + std::string gen_base_function_class_name() const final { + return "Function"; + } + + static std::string to_camelCase(const std::string &name) { + return to_cCamelCase(name, false); + } + static std::string to_CamelCase(const std::string &name) { + return to_cCamelCase(name, true); + } + static std::string to_cCamelCase(const std::string &name, bool flag) { + bool next_to_upper = flag; + std::string result; + for (std::size_t i = 0; i < name.size(); i++) { + if (!is_alnum(name[i])) { + next_to_upper = true; + continue; + } + if (next_to_upper) { + result += to_upper(name[i]); + next_to_upper = false; + } else { + result += name[i]; + } + } + return result; + } + + std::string gen_native_field_name(std::string name) const { + for (std::size_t i = 0; i < name.size(); i++) { + if (!is_alnum(name[i])) { + name[i] = '_'; + } + } + assert(name.size() > 0); + assert(name[name.size() - 1] != '_'); + return name + "_"; + } + + std::string gen_native_class_name(std::string name) const { + if (name == "Object") { + assert(false); + } + if (name == "#") { + return "int"; + } + for (std::size_t i = 0; i < name.size(); i++) { + if (!is_alnum(name[i])) { + name[i] = '_'; + } + } + return name; + } + + std::string gen_class_name(std::string name) const final { + if (name == "Object" || name == "#") { + assert(false); + } + return to_CamelCase(name); + } + std::string gen_field_name(std::string name) const final { + return gen_native_field_name(name); + } + + std::string gen_native_type_name(const tl::tl_tree_type *tree_type, bool storage) const { + const tl::tl_type *t = tree_type->type; + const std::string &name = t->name; + + if (name == "#") { + assert(false); + } + if (name == "Bool") { + return "bool"; + } + if (name == "Int32") { + return "std::int32_t"; + } + if (name == "Int53" || name == "Int64") { + return "std::int64_t"; + } + if (name == "Double") { + return "double"; + } + if (name == "String") { + return "std::string"; + } + if (name == "Bytes") { + return "std::string"; + } + + if (name == "Vector") { + assert(t->arity == 1); + assert(tree_type->children.size() == 1); + assert(tree_type->children[0]->get_type() == tl::NODE_TYPE_TYPE); + const tl::tl_tree_type *child = static_cast(tree_type->children[0]); + + return "std::vector<" + gen_native_type_name(child, storage) + ">"; + } + + assert(!is_built_in_simple_type(name) && !is_built_in_complex_type(name)); + + for (std::size_t i = 0; i < tree_type->children.size(); i++) { + assert(tree_type->children[i]->get_type() == tl::NODE_TYPE_NAT_CONST); + } + + std::string native_class_name = gen_native_class_name(t->name); + if (t->constructors_num == 1) { + native_class_name = gen_native_class_name(t->constructors[0]->name); + } + return storage ? "td::td_api::object_ptr" + : "td::td_api::" + native_class_name + ""; + } + + std::string gen_type_name(const tl::tl_tree_type *tree_type, bool force) const { + const tl::tl_type *t = tree_type->type; + const std::string &name = t->name; + + if (name == "#") { + assert(false); + } + if (name == "Bool") { + return force ? "Int" : "int "; + } + if (name == "Int32") { + return force ? "Int" : "int "; + } + if (name == "Int53" || name == "Int64") { + return force ? "Long" : "long long "; + } + if (name == "Double") { + return force ? "Double" : "double "; + } + if (name == "String") { + return force ? "String" : "char *"; + } + if (name == "Bytes") { + return force ? "Bytes" : "struct TdBytes "; + } + + if (name == "Vector") { + assert(t->arity == 1); + assert(tree_type->children.size() == 1); + assert(tree_type->children[0]->get_type() == tl::NODE_TYPE_TYPE); + const tl::tl_tree_type *child = static_cast(tree_type->children[0]); + + return !force ? ("struct TdVector" + gen_type_name(child, true) + " *") : ("Vector" + gen_type_name(child, true)); + } + + assert(!is_built_in_simple_type(name) && !is_built_in_complex_type(name)); + + for (std::size_t i = 0; i < tree_type->children.size(); i++) { + assert(tree_type->children[i]->get_type() == tl::NODE_TYPE_NAT_CONST); + } + + return !force ? ("struct Td" + gen_main_class_name(t) + " *") : gen_main_class_name(t); + } + std::string gen_type_name(const tl::tl_tree_type *tree_type) const final { + return gen_type_name(tree_type, false); + } + std::string gen_output_begin(const std::string &additional_imports) const final { + if (is_header_ == 1) { + return "#pragma once\n\n" + additional_imports + + "#ifdef __cplusplus\n" + "extern \"C\" {\n" + "#endif\n"; + } + if (is_header_ == -1) { + return "#pragma once\n\n" + gen_import_declaration("td/telegram/td_tdc_api.h", false) + + gen_import_declaration("td/telegram/td_api.h", false) + "\n" + additional_imports; + } + return gen_import_declaration("td/telegram/td_tdc_api_inner.h", false) + "\n" + + gen_import_declaration("td/utils/format.h", false) + gen_import_declaration("td/utils/logging.h", false) + + gen_import_declaration("td/utils/misc.h", false) + gen_import_declaration("td/utils/Slice.h", false) + "\n" + + additional_imports; + } + + std::string gen_output_begin_once() const final { + if (is_header_ == 1) { + return "struct TdBytes {\n" + " unsigned char *data;\n" + " int len;\n" + "};\n" + "#define TDC_VECTOR(tdc_type_name,tdc_type) \\\n" + " struct TdVector ## tdc_type_name { \\\n" + " int len;\\\n" + " tdc_type *data;\\\n" + " };\\\n" + "\n" + "TDC_VECTOR(Int,int)\n" + "TDC_VECTOR(Long,long long)\n" + "TDC_VECTOR(String,char *)\n" + "TDC_VECTOR(Bytes,struct TdBytes)\n" + "struct TdStackStorerMethods {\n" + " void (*pack_string)(const char *s);\n" + " void (*pack_bytes)(const unsigned char *s, int len);\n" + " void (*pack_long)(long long x);\n" + " void (*pack_double)(double x);\n" + " void (*pack_bool)(int x);\n" + " void (*new_table)(void);\n" + " void (*new_array)(void);\n" + " void (*new_field)(const char *name);\n" + " void (*new_arr_field)(int idx);\n" + "};\n" + "struct TdStackFetcherMethods {\n" + " char *(*get_string)(void);\n" + " unsigned char *(*get_bytes)(int *len);\n" + " long long (*get_long)(void);\n" + " double (*get_double)(void);\n" + " void (*pop)(void);\n" + " void (*get_field)(const char *name);\n" + " void (*get_arr_field)(int idx);\n" + " int (*get_arr_size)(void);\n" + " int (*is_nil)(void);\n" + "};\n"; + } + return std::string(); + } + + std::string gen_output_end() const final { + if (is_header_ == 1) { + return "#ifdef __cplusplus\n" + "}\n" + "#endif\n"; + } else if (is_header_ == -1) { + return ""; + } + return ""; + } + + std::string gen_import_declaration(const std::string &name, bool is_system) const final { + if (is_system) { + return "#include <" + name + ">\n"; + } else { + return "#include \"" + name + "\"\n"; + } + } + + std::string gen_package_suffix() const final { + return ".h"; + } + + std::string gen_forward_class_declaration(const std::string &class_name, bool is_proxy) const final { + if (is_header_ != 1 || class_name == "") { + return ""; + } + return "struct Td" + class_name + + ";\n" + "struct TdVector" + + class_name + + ";\n" + "struct TdVectorVector" + + class_name + ";\n"; + } + + std::string gen_class_begin(const std::string &class_name, const std::string &base_class_name, bool is_proxy, + const tl::tl_tree *result) const final { + if (is_header_ != 1 || class_name == "") { + return ""; + } + + std::string tail = ""; + if (class_name == "Function" || class_name == "Object") { + tail = "};\n"; + } + return "TDC_VECTOR(" + class_name + ", struct Td" + class_name + + " *);\n" + "TDC_VECTOR(Vector" + + class_name + ", struct TdVector" + class_name + + " *);\n" + "struct Td" + + class_name + " {\n" + " int ID;\n int refcnt;\n" + tail; + } + std::string gen_class_end() const final { + return ""; + } + + std::string gen_field_definition(const std::string &class_name, const std::string &type_name, + const std::string &field_name) const final { + if (is_header_ != 1 || class_name == "") { + return ""; + } + return " " + type_name + field_name + ";\n"; + } + + std::string gen_store_function_begin(const std::string &storer_name, const std::string &class_name, int arity, + std::vector &vars, int storer_type) const final { + return ""; + } + std::string gen_store_function_end(const std::vector &vars, int storer_type) const final { + return ""; + } + + std::string gen_constructor_begin(int field_count, const std::string &class_name, bool is_default) const final { + if (!is_default || is_header_ == -1 || class_name == "") { + return ""; + } + std::stringstream ss; + if (is_header_ == 1) { + ss << "};\n"; + } + ss << "struct Td" + gen_class_name(class_name) + " *TdCreateObject" + gen_class_name(class_name) + " (" + + (field_count ? "" : "void"); + return ss.str(); + } + std::string gen_constructor_parameter(int field_num, const std::string &class_name, const tl::arg &a, + bool is_default) const final { + if (!is_default || is_header_ == -1) { + return ""; + } + std::stringstream ss; + auto field_type = gen_field_type(a); + ss << (field_num == 0 ? "" : ", "); + ss << field_type << gen_field_name(a.name); + return ss.str(); + } + std::string gen_constructor_field_init(int field_num, const std::string &class_name, const tl::arg &a, + bool is_default) const final { + return ""; + } + std::string gen_constructor_end(const tl::tl_combinator *t, int field_count, bool is_default) const final { + if (!is_default || is_header_ == -1) { + return ""; + } + if (is_header_ == 1) { + return ");\n"; + } + std::stringstream ss; + ss << ") {\n"; + auto type_name = "struct Td" + gen_class_name(t->name); + ss << " auto var = new " << type_name << " ();\n"; + ss << " var->ID = CODE_" << gen_class_name(t->name) << ";\n"; + ss << " var->refcnt = 1;\n"; + for (auto &it : t->args) { + const tl::tl_tree_type *T = static_cast(it.type); + auto field_name = gen_field_name(it.name); + if (T->type->name == "String") { + ss << " var->" << field_name << " = (" << field_name << ") ? td::str_dup (td::Slice (" << field_name + << ")) : nullptr;\n"; + } else { + ss << " var->" << field_name << " = " << field_name << ";\n"; + } + } + ss << " return var;\n}\n"; + return ss.str(); + } + std::string gen_additional_function(const std::string &function_name, const tl::tl_combinator *t, + bool is_function) const final { + std::stringstream ss; + if (function_name == "enum") { + return ss.str(); + } + if (function_name == "TdDestroyObject") { + auto class_name = gen_class_name(t->name); + if (is_header_ == 1) { + ss << "void TdDestroyObject" + class_name + " (struct Td" + class_name + " *var);\n"; + return ss.str(); + } + if (is_header_ == -1) { + ss << "void TdDestroyObject (struct Td" + class_name + " *var);\n"; + return ss.str(); + } + ss << "void TdDestroyObject" + class_name + " (struct Td" + class_name + " *var) {\n"; + ss << " TdDestroyObject (var);\n"; + ss << "}\n"; + ss << "void TdDestroyObject (struct Td" + class_name + " *var)"; + + file_store_methods_destroy M(this); + gen_object_store(ss, t, M); + return ss.str(); + } + if (function_name == "TdSerialize" && is_header_ != -1) { + auto class_name = gen_class_name(t->name); + ss << "char *TdSerialize" + class_name + " (struct Td" + class_name + " *var)"; + if (is_header_ == 1) { + ss << ";\n"; + return ss.str(); + } + ss << " {\n"; + ss << " return td::str_dup (TdToString (var));\n"; + ss << "}\n"; + return ss.str(); + } + if (function_name == "TdToString" && is_header_ != 1) { + auto class_name = gen_class_name(t->name); + ss << "std::string TdToString (struct Td" + class_name + " *var)"; + if (is_header_ == -1) { + ss << ";\n"; + return ss.str(); + } + ss << " {\n"; + ss << " return to_string (TdConvertToInternal (var));\n"; + ss << "}\n"; + return ss.str(); + } + if (function_name == "TdConvertToInternal" && is_header_ != 1) { + auto class_name = gen_class_name(t->name); + auto native_class_name = gen_native_class_name(t->name); + ss << "td::td_api::object_ptr TdConvertToInternal (struct Td" + class_name + " *var)"; + if (is_header_ == -1) { + ss << ";\n"; + return ss.str(); + } + file_store_methods_to_td M(this); + gen_object_store(ss, t, M); + return ss.str(); + } + if (function_name == "TdConvertFromInternal" && is_header_ != 1) { + auto class_name = gen_class_name(t->name); + auto native_class_name = gen_native_class_name(t->name); + ss << "struct Td" << class_name << " *TdConvertFromInternal (const td::td_api::" << native_class_name + << " &from)"; + if (is_header_ == -1) { + ss << ";\n"; + return ss.str(); + } + file_fetch_methods_from_td M(this); + gen_object_fetch(ss, t, M); + return ss.str(); + } + if (function_name == "TdStackStorer") { + auto class_name = gen_class_name(t->name); + if (is_header_ == 1) { + ss << "void TdStackStorer" + class_name + " (struct Td" + class_name + + " *var, struct TdStackStorerMethods *M);\n"; + return ss.str(); + } + if (is_header_ == -1) { + ss << "void TdStackStorer (struct Td" + class_name + " *var, struct TdStackStorerMethods *M);\n"; + return ss.str(); + } + ss << "void TdStackStorer" + class_name + " (struct Td" + class_name + + " *var, struct TdStackStorerMethods *M) {\n"; + ss << " TdStackStorer (var, M);\n"; + ss << "}\n"; + ss << "void TdStackStorer (struct Td" + class_name + " *var, struct TdStackStorerMethods *M)"; + + file_store_methods_stack M(this); + gen_object_store(ss, t, M); + return ss.str(); + } + if (function_name == "TdStackFetcher" && is_header_ != -1) { + auto class_name = gen_class_name(t->name); + ss << "struct Td" << class_name << " *TdStackFetcher" + class_name + " (struct TdStackFetcherMethods *M)"; + if (is_header_ == 1) { + ss << ";\n"; + return ss.str(); + } + + file_fetch_methods_stack M(this); + gen_object_fetch(ss, t, M); + return ss.str(); + } + return ss.str(); + } + + struct file_store_methods { + file_store_methods() = default; + file_store_methods(const file_store_methods &) = delete; + file_store_methods &operator=(const file_store_methods &) = delete; + virtual ~file_store_methods() = default; + virtual void store_simple_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const { + assert(false); + } + virtual void store_common_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const { + assert(false); + } + virtual void store_array_start(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const { + assert(false); + } + virtual void store_array_el(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string idx) const { + assert(false); + } + virtual void store_array_finish(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const { + assert(false); + } + virtual void store_nil(std::stringstream &ss, std::string offset) const { + assert(false); + } + virtual std::string store_field_start(std::stringstream &ss, std::string offset, int depth, + const tl::tl_tree_type *tree_type) const { + assert(false); + return ""; + } + virtual void store_field_finish(std::stringstream &ss, std::string offset, std::string res_var) const { + assert(false); + } + virtual void store_arg_finish(std::stringstream &ss, std::string offset, std::string arg_name, + std::string res_var) const { + assert(false); + } + virtual void store_constructor_start(std::stringstream &ss, std::string offset, const tl::tl_combinator *t) const { + } + virtual void store_constructor_finish(std::stringstream &ss, std::string offset, const tl::tl_combinator *t, + std::vector res_var) const { + assert(false); + } + }; + + struct file_store_methods_to_td final : public file_store_methods { + explicit file_store_methods_to_td(const class TlWriterCCommon *cl) : cl(cl) { + } + void store_simple_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const final { + if (type_name == "String") { + ss << offset << res_var << " = (" << var << ") ? " << var << ": \"\";\n"; + } else if (type_name == "Bytes") { + ss << offset << res_var << " = std::string ((char *)" << var << ".data, " << var << ".len);\n"; + } else if (type_name == "Bool") { + ss << offset << res_var << " = " << var << " != 0;\n"; + } else { + ss << offset << res_var << " = " << var << ";\n"; + } + } + void store_common_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const final { + ss << offset << res_var << " = TdConvertToInternal (" << var << ");\n"; + } + void store_array_start(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + } + void store_array_el(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string idx) const final { + ss << offset << res_var << ".push_back (std::move (" << var << "));\n"; + } + void store_array_finish(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + } + void store_nil(std::stringstream &ss, std::string offset) const final { + ss << offset << "return nullptr;\n"; + } + std::string store_field_start(std::stringstream &ss, std::string offset, int depth, + const tl::tl_tree_type *tree_type) const final { + std::string res_var = "v" + int_to_string(depth); + ss << offset << cl->gen_native_type_name(tree_type, true) << " " << res_var << ";\n"; + return res_var; + } + void store_field_finish(std::stringstream &ss, std::string offset, std::string res_var) const final { + } + void store_arg_finish(std::stringstream &ss, std::string offset, std::string arg_name, + std::string res_var) const final { + } + void store_constructor_finish(std::stringstream &ss, std::string offset, const tl::tl_combinator *t, + std::vector res_var) const final { + auto native_class_name = cl->gen_native_class_name(t->name); + ss << offset << "return td::td_api::make_object("; + bool is_first = true; + for (auto &var_name : res_var) { + if (is_first) { + is_first = false; + } else { + ss << ", "; + } + + ss << "std::move (" << var_name << ")"; + } + ss << ");\n"; + } + const class TlWriterCCommon *cl; + }; + + struct file_store_methods_destroy final : public file_store_methods { + explicit file_store_methods_destroy(const class TlWriterCCommon *cl) : cl(cl) { + } + void store_simple_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const final { + if (type_name == "String") { + ss << offset << "free (" << var << ");\n"; + } else if (type_name == "Bytes") { + ss << offset << "delete[]" << var << ".data;\n"; + } + } + void store_common_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const final { + ss << offset << "TdDestroyObject (" << var << ");\n"; + } + void store_array_start(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + } + void store_array_el(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string idx) const final { + } + void store_array_finish(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + ss << offset << "delete[] " << var << "->data;\n" << offset << "delete " << var << ";\n"; + } + void store_nil(std::stringstream &ss, std::string offset) const final { + ss << offset << "return;\n"; + } + std::string store_field_start(std::stringstream &ss, std::string offset, int depth, + const tl::tl_tree_type *tree_type) const final { + return ""; + } + void store_field_finish(std::stringstream &ss, std::string offset, std::string res_var) const final { + } + void store_arg_finish(std::stringstream &ss, std::string offset, std::string arg_name, + std::string res_var) const final { + } + void store_constructor_start(std::stringstream &ss, std::string offset, const tl::tl_combinator *t) const final { + ss << "#if TD_MSVC\n"; + ss << offset << "static_assert (sizeof (long) == sizeof (var->refcnt), \"Illegal InterlockedDecrement\");\n"; + ss << offset << "int ref = InterlockedDecrement (reinterpret_cast(&var->refcnt));\n"; + ss << "#else\n"; + ss << offset << "int ref = __sync_add_and_fetch (&var->refcnt, -1);\n"; + ss << "#endif\n"; + ss << offset << "if (ref < 0) {\n"; + ss << offset << " LOG(FATAL) << \"Negative reference counter in Td C object struct\";\n"; + ss << offset << "}\n"; + ss << offset << "if (ref > 0) {\n"; + ss << offset << " return;\n"; + ss << offset << "}\n"; + } + void store_constructor_finish(std::stringstream &ss, std::string offset, const tl::tl_combinator *t, + std::vector res_var) const final { + ss << offset << "delete var;\n"; + } + const class TlWriterCCommon *cl; + }; + struct file_store_methods_stack final : public file_store_methods { + explicit file_store_methods_stack(const class TlWriterCCommon *cl) : cl(cl) { + } + void store_simple_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const final { + if (type_name == "String") { + ss << offset << "M->pack_string (" << var << ");\n"; + } else if (type_name == "Bytes") { + ss << offset << "M->pack_bytes (" << var << ".data, " << var << ".len);\n"; + } else if (type_name == "Int32" || type_name == "Int53" || type_name == "Int64") { + ss << offset << "M->pack_long (" << var << ");\n"; + } else if (type_name == "Bool") { + ss << offset << "M->pack_bool (" << var << ");\n"; + } else if (type_name == "Double") { + ss << offset << "M->pack_double (" << var << ");\n"; + } else { + ss << "????" << type_name << "\n"; + } + } + void store_common_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const final { + ss << offset << "TdStackStorer (" << var << ", M);\n"; + } + void store_array_start(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + ss << offset << "M->new_array ();\n"; + } + void store_array_el(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string idx) const final { + ss << offset << "M->new_arr_field (" << idx << ");\n"; + } + void store_array_finish(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + } + void store_nil(std::stringstream &ss, std::string offset) const final { + ss << offset << "M->pack_bool (0);\n" << offset << "return;\n"; + } + std::string store_field_start(std::stringstream &ss, std::string offset, int depth, + const tl::tl_tree_type *tree_type) const final { + return ""; + } + void store_field_finish(std::stringstream &ss, std::string offset, std::string res_var) const final { + } + void store_arg_finish(std::stringstream &ss, std::string offset, std::string arg_name, + std::string res_var) const final { + ss << offset << "M->new_field (\"" << arg_name << "\");\n"; + } + void store_constructor_start(std::stringstream &ss, std::string offset, const tl::tl_combinator *t) const final { + ss << offset << "M->new_table ();\n"; + auto class_name = cl->gen_class_name(t->name); + ss << offset << "M->pack_string (\"" << class_name << "\");\n"; + ss << offset << "M->new_field (\"ID\");\n"; + } + void store_constructor_finish(std::stringstream &ss, std::string offset, const tl::tl_combinator *t, + std::vector res_var) const final { + } + const class TlWriterCCommon *cl; + }; + + struct file_fetch_methods { + file_fetch_methods() = default; + file_fetch_methods(const file_fetch_methods &) = delete; + file_fetch_methods &operator=(const file_fetch_methods &) = delete; + + virtual ~file_fetch_methods() = default; + + virtual std::string fetch_field_start(std::stringstream &ss, std::string offset, int depth, + const tl::tl_tree_type *tree_type) const { + assert(false); + return ""; + } + virtual void fetch_simple_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const { + assert(false); + } + virtual void fetch_common_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const { + assert(false); + } + virtual void fetch_array_size(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const { + assert(false); + } + virtual std::string fetch_array_field_start(std::stringstream &ss, std::string offset, std::string res_var, + std::string var, std::string idx, + const tl::tl_tree_type *tree_type) const { + assert(false); + return ""; + } + virtual std::string fetch_dict_field_start(std::stringstream &ss, std::string offset, std::string res_var, + std::string var, std::string key, + const tl::tl_tree_type *tree_type) const { + assert(false); + return ""; + } + virtual void fetch_field_finish(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const { + assert(false); + } + }; + + struct file_fetch_methods_from_td final : public file_fetch_methods { + explicit file_fetch_methods_from_td(const class TlWriterCCommon *cl) : cl(cl) { + } + std::string fetch_field_start(std::stringstream &ss, std::string offset, int depth, + const tl::tl_tree_type *tree_type) const final { + return ""; + } + void fetch_simple_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const final { + if (type_name == "String") { + ss << offset << res_var << " = (" << var << ".length ()) ? td::str_dup (" << var << ") : nullptr;\n"; + } else if (type_name == "Bytes") { + ss << offset << res_var << ".len = (int)" << var << ".length ();\n"; + ss << offset << "if (" << res_var << ".len) {\n"; + ss << offset << " " << res_var << ".data = new unsigned char[" << res_var << ".len];\n"; + ss << offset << " memcpy (" << res_var << ".data, " << var << ".c_str (), " << res_var << ".len);\n"; + ss << offset << "} else {\n"; + ss << offset << " " << res_var << ".data = nullptr;\n"; + ss << offset << "}\n"; + } else { + ss << offset << res_var << " = " << var << ";\n"; + } + } + void fetch_common_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + auto native_type_name = cl->gen_native_type_name(tree_type, false); + ss << offset << "if (!" << var << ") {\n" + << offset << " " << res_var << " = nullptr;\n" + << offset << "} else {\n" + << offset << " " << res_var << " = TdConvertFromInternal (static_cast(*" + << var << "));\n" + << offset << "}\n"; + } + void fetch_array_size(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + ss << offset << res_var << " = (int)" << var << ".size ();\n"; + } + std::string fetch_array_field_start(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string idx, const tl::tl_tree_type *tree_type) const final { + return var + "[" + idx + "]"; + } + std::string fetch_dict_field_start(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string key, const tl::tl_tree_type *tree_type) const final { + return var + "." + key; + } + void fetch_field_finish(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + } + const class TlWriterCCommon *cl; + }; + + struct file_fetch_methods_stack final : public file_fetch_methods { + explicit file_fetch_methods_stack(const class TlWriterCCommon *cl) : cl(cl) { + } + std::string fetch_field_start(std::stringstream &ss, std::string offset, int depth, + const tl::tl_tree_type *tree_type) const final { + return ""; + } + void fetch_simple_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string type_name) const final { + if (type_name == "String") { + ss << offset << res_var << " = M->get_string ();\n"; + } else if (type_name == "Bytes") { + ss << offset << res_var << ".data = M->get_bytes (&" << res_var << ".len);\n"; + } else if (type_name == "Int32" || type_name == "Bool") { + ss << offset << res_var << " = (int)M->get_long ();\n"; + } else if (type_name == "Int53" || type_name == "Int64") { + ss << offset << res_var << " = M->get_long ();\n"; + } else if (type_name == "Double") { + ss << offset << res_var << " = M->get_double ();\n"; + } else { + ss << "??????" << type_name << "\n"; + } + } + void fetch_common_type(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + auto class_name = cl->gen_main_class_name(tree_type->type); + ss << offset << "if (M->is_nil ()) {\n" + << offset << " " << res_var << " = nullptr;\n" + << offset << "} else {\n" + << offset << " " << res_var << " = TdStackFetcher" << class_name << " (M);\n" + << offset << "}\n"; + } + void fetch_array_size(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + ss << offset << res_var << " = M->get_arr_size ();\n"; + } + std::string fetch_array_field_start(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string idx, const tl::tl_tree_type *tree_type) const final { + ss << offset << " M->get_arr_field (" << idx << ");\n"; + return ""; + } + std::string fetch_dict_field_start(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + std::string key, const tl::tl_tree_type *tree_type) const final { + ss << offset << "M->get_field (\"" << key << "\");\n"; + return ""; + } + void fetch_field_finish(std::stringstream &ss, std::string offset, std::string res_var, std::string var, + const tl::tl_tree_type *tree_type) const final { + ss << offset << "M->pop ();\n"; + } + const class TlWriterCCommon *cl; + }; + + std::string gen_field_store(std::stringstream &ss, std::string offset, std::string var, int depth, + const tl::tl_tree_type *tree_type, const file_store_methods &M) const { + std::string res_var = M.store_field_start(ss, offset, depth, tree_type); + if (is_built_in_simple_type(tree_type->type->name)) { + M.store_simple_type(ss, offset, res_var, var, tree_type->type->name); + } else if (!is_built_in_complex_type(tree_type->type->name)) { + M.store_common_type(ss, offset, res_var, var, tree_type->type->name); + } else { + const tl::tl_tree_type *child = static_cast(tree_type->children[0]); + + std::string it = "i" + int_to_string(depth); + + M.store_array_start(ss, offset, res_var, var, tree_type); + ss << offset << "for (int " << it << " = 0; " << it << " < " << var << "->len; " << it << "++) {\n"; + auto f_res_var = gen_field_store(ss, offset + " ", var + "->data[" + it + "]", depth + 1, child, M); + M.store_array_el(ss, offset + " ", res_var, f_res_var, it); + ss << offset << "}\n"; + M.store_array_finish(ss, offset, res_var, var, tree_type); + } + M.store_field_finish(ss, offset, res_var); + return res_var; + } + void gen_object_store(std::stringstream &ss, const tl::tl_combinator *t, const file_store_methods &M) const { + ss << " {\n" + << " if (!var) {\n"; + M.store_nil(ss, " "); + ss << " }\n"; + M.store_constructor_start(ss, " ", t); + + std::vector flds; + int d = 0; + for (auto &it : t->args) { + const tl::tl_tree_type *tree_type = static_cast(it.type); + flds.push_back(gen_field_store(ss, " ", "var->" + gen_field_name(it.name), 100 * d, tree_type, M)); + d++; + M.store_arg_finish(ss, " ", gen_field_name(it.name), flds[d - 1]); + } + M.store_constructor_finish(ss, " ", t, flds); + ss << "}\n"; + } + void gen_field_fetch(std::stringstream &ss, std::string offset, std::string res_var, std::string var, int depth, + const tl::tl_tree_type *tree_type, const file_fetch_methods &M) const { + if (is_built_in_simple_type(tree_type->type->name)) { + M.fetch_simple_type(ss, offset, res_var, var, tree_type->type->name); + } else if (!is_built_in_complex_type(tree_type->type->name)) { + M.fetch_common_type(ss, offset, res_var, var, tree_type); + } else { + const tl::tl_tree_type *child = static_cast(tree_type->children[0]); + + ss << offset << res_var << " = new Td" << gen_type_name(tree_type, true) << " ();\n"; + M.fetch_array_size(ss, offset, res_var + "->len", var, tree_type); + ss << offset << res_var << "->data = new " << gen_type_name(child) << " [" << res_var << "->len];\n"; + + std::string it = "i" + int_to_string(depth); + ss << offset << "for (int " << it << " = 0; " << it << " < " << res_var << "->len; " << it << "++) {\n"; + auto new_var = M.fetch_array_field_start(ss, offset, res_var, var, it, child); + gen_field_fetch(ss, offset + " ", res_var + "->data[" + it + "]", new_var, depth + 1, child, M); + ss << offset << "}\n"; + } + M.fetch_field_finish(ss, offset, res_var, var, tree_type); + } + void gen_object_fetch(std::stringstream &ss, const tl::tl_combinator *t, const file_fetch_methods &M) const { + auto type_name = gen_class_name(t->name); + ss << " {\n" + << " auto res = new Td" << type_name << " ();\n" + << " res->ID = CODE_" << type_name << ";\n" + << " res->refcnt = 1;\n"; + int d = 0; + for (auto &it : t->args) { + const tl::tl_tree_type *tree_type = static_cast(it.type); + auto new_var = M.fetch_dict_field_start(ss, " ", "res", "from", gen_field_name(it.name), tree_type); + gen_field_fetch(ss, " ", "res->" + gen_field_name(it.name), new_var, 100 * d, tree_type, M); + d++; + } + ss << " return res;\n" + << "}\n"; + } + + std::string gen_array_type_name(const tl::tl_tree_array *arr, const std::string &field_name) const final { + assert(false); + return std::string(); + } + std::string gen_var_type_name() const final { + assert(false); + return std::string(); + } + + std::string gen_int_const(const tl::tl_tree *tree_c, const std::vector &vars) const final { + assert(false); + return std::string(); + } + + std::string gen_var_name(const tl::var_description &desc) const final { + assert(false); + return ""; + } + std::string gen_parameter_name(int index) const final { + assert(false); + return ""; + } + + std::string gen_class_alias(const std::string &class_name, const std::string &alias_name) const final { + return ""; + } + + std::string gen_vars(const tl::tl_combinator *t, const tl::tl_tree_type *result_type, + std::vector &vars) const final { + assert(vars.empty()); + return ""; + } + std::string gen_function_vars(const tl::tl_combinator *t, std::vector &vars) const final { + assert(vars.empty()); + return ""; + } + std::string gen_uni(const tl::tl_tree_type *result_type, std::vector &vars, + bool check_negative) const final { + assert(result_type->children.empty()); + return ""; + } + std::string gen_constructor_id_store(std::int32_t id, int storer_type) const final { + return ""; + } + std::string gen_field_fetch(int field_num, const tl::arg &a, std::vector &vars, bool flat, + int parser_type) const final { + return ""; + } + std::string gen_field_store(const tl::arg &a, const std::vector &args, + std::vector &vars, bool flat, int storer_type) const final { + return ""; + } + std::string gen_type_fetch(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int parser_type) const final { + assert(vars.empty()); + return ""; + } + + std::string gen_type_store(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int storer_type) const final { + return ""; + } + std::string gen_var_type_fetch(const tl::arg &a) const final { + assert(false); + return ""; + } + + std::string gen_get_id(const std::string &class_name, std::int32_t id, bool is_proxy) const final { + if (is_proxy || is_header_ != 1) { + return ""; + } + return ""; + } + + std::string gen_function_result_type(const tl::tl_tree *result) const final { + return ""; + } + + std::string gen_fetch_function_begin(const std::string &parser_name, const std::string &class_name, + const std::string &parent_class_name, int arity, int field_count, + std::vector &vars, int parser_type) const final { + return ""; + } + std::string gen_fetch_function_end(bool has_parent, int field_count, const std::vector &vars, + int parser_type) const final { + return ""; + } + + std::string gen_fetch_function_result_begin(const std::string &parser_name, const std::string &class_name, + const tl::tl_tree *result) const final { + return ""; + } + std::string gen_fetch_function_result_end() const final { + return ""; + } + std::string gen_fetch_function_result_any_begin(const std::string &parser_name, const std::string &class_name, + bool is_proxy) const final { + return ""; + } + std::string gen_fetch_function_result_any_end(bool is_proxy) const final { + return ""; + } + + std::string gen_fetch_switch_begin() const final { + return ""; + } + std::string gen_fetch_switch_case(const tl::tl_combinator *t, int arity) const final { + return ""; + } + std::string gen_fetch_switch_end() const final { + return ""; + } + + std::string gen_additional_proxy_function_begin(const std::string &function_name, const tl::tl_type *type, + const std::string &name, int arity, bool is_function) const final { + std::stringstream ss; + std::string class_name; + std::string native_class_name; + + if (type != nullptr) { + class_name = gen_main_class_name(type); + native_class_name = gen_native_class_name(type->name); + } else { + if (is_function) { + class_name = "Function"; + native_class_name = "Function"; + } else { + class_name = "Object"; + native_class_name = "Object"; + } + } + if (is_header_ == 1 && function_name == "TdConvertToInternal" && type != nullptr && !is_function) { + ss << "};\n"; + } + + if (function_name == "enum") { + if (is_header_ != 1) { + return ss.str(); + } + ss << "enum List_" + class_name << " {\n"; + return ss.str(); + } + + if (function_name == "TdDestroyObject") { + if (is_header_ == 1) { + ss << "void TdDestroyObject" + class_name + " (struct Td" + class_name + " *var);\n"; + return ss.str(); + } + if (is_header_ == -1) { + ss << "void TdDestroyObject (struct Td" + class_name + " *var);\n"; + return ss.str(); + } + ss << "void TdDestroyObject" + class_name + " (struct Td" + class_name + " *var) {\n"; + ss << " TdDestroyObject (var);\n"; + ss << "}\n"; + ss << "void TdDestroyObject (struct Td" + class_name + " *var)"; + } + if (function_name == "TdSerialize" && is_header_ != -1) { + ss << "char *TdSerialize" + class_name + " (struct Td" + class_name + " *var)"; + if (is_header_ == 1) { + ss << ";\n"; + return ss.str(); + } + ss << " {\n"; + ss << " return td::str_dup (TdToString (var));\n"; + ss << "}\n"; + return ss.str(); + } + if (function_name == "TdToString" && is_header_ != 1) { + ss << "std::string TdToString (struct Td" + class_name + " *var)"; + if (is_header_ == -1) { + ss << ";\n"; + return ss.str(); + } + ss << " {\n"; + ss << " return to_string (TdConvertToInternal (var));\n"; + ss << "}\n"; + return ss.str(); + } + if (function_name == "TdConvertToInternal" && is_header_ != 1) { + ss << "td::td_api::object_ptr TdConvertToInternal (struct Td" + class_name + " *var)"; + if (is_header_ == -1) { + ss << ";\n"; + return ss.str(); + } + } + if (function_name == "TdConvertFromInternal" && is_header_ != 1) { + ss << "struct Td" << class_name << " *TdConvertFromInternal (const td::td_api::" << native_class_name + << " &from)"; + if (is_header_ == -1) { + ss << ";\n"; + return ss.str(); + } + } + if (function_name == "TdStackStorer") { + if (is_header_ == 1) { + ss << "void TdStackStorer" + class_name + " (struct Td" + class_name + + " *var, struct TdStackStorerMethods *M);\n"; + return ss.str(); + } + if (is_header_ == -1) { + ss << "void TdStackStorer (struct Td" + class_name + " *var, struct TdStackStorerMethods *M);\n"; + return ss.str(); + } + ss << "void TdStackStorer" + class_name + " (struct Td" + class_name + + " *var, struct TdStackStorerMethods *M) {\n"; + ss << " TdStackStorer (var, M);\n"; + ss << "}\n"; + ss << "void TdStackStorer (struct Td" + class_name + " *var, struct TdStackStorerMethods *M)"; + } + if (function_name == "TdStackFetcher" && is_header_ != -1) { + ss << "struct Td" << class_name << " *TdStackFetcher" + class_name + " (struct TdStackFetcherMethods *M)"; + if (is_header_ == 1) { + ss << ";\n"; + return ss.str(); + } + } + if (is_header_ != 0) { + return ss.str(); + } + + if (function_name == "TdDestroyObject" || function_name == "TdConvertToInternal" || + function_name == "TdStackStorer") { + ss << " {\n"; + std::string prefix = ""; + if (function_name == "TdConvertToInternal") { + prefix = " if (!var) { return nullptr; }\n"; + } else if (function_name == "TdDestroyObject") { + prefix = " if (!var) { return; }\n"; + } + if (function_name == "TdStackStorer") { + prefix = " if (!var) { M->pack_bool (0); return; }\n"; + } + ss << prefix + << " int constructor = var->ID;\n" + " switch (constructor) {\n"; + } else if (function_name == "TdConvertFromInternal") { + ss << " {\n" + //" if (!from) { return nullptr; }\n" + " int constructor = from.get_id ();\n" + " switch (constructor) {\n"; + } else if (function_name == "TdStackFetcher") { + ss << " {\n" + " M->get_field (\"ID\");\n" + " char *constructor_old = M->get_string ();\n" + " M->pop ();\n" + " std::string constructor = constructor_old;\n" + " free (constructor_old);\n" + " "; + } else { + ss << "??????"; + } + + return ss.str(); + } + + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl::tl_type *type, + const std::string &class_name, int arity) const final { + if (is_header_ != (function_name == "enum" ? 1 : 0)) { + return ""; + } + + assert(type != nullptr); + if (function_name == "TdDestroyObject" || function_name == "TdConvertToInternal" || + function_name == "TdStackStorer") { + std::string extra_arg = ""; + if (function_name == "TdStackStorer") { + extra_arg = ", M"; + } + return " case CODE_" + class_name + ": return " + function_name + " ((struct Td" + class_name + " *)var" + + extra_arg + ");\n"; + } else if (function_name == "TdConvertFromInternal") { + std::string native_class_name = class_name; + native_class_name[0] = to_lower(native_class_name[0]); + return " case CODE_" + class_name + ": return (struct TdNullaryObject *)" + function_name + + "(static_cast(from));\n"; + } else if (function_name == "TdStackFetcher") { + return "if (constructor == \"" + class_name + + "\") {\n" + " return (struct TdNullaryObject *)TdStackFetcher" + + class_name + + " (M);\n" + " }\n "; + } else if (function_name == "enum") { + // return " CODE_" + class_name + " = " + int_to_string (t->id) + ",\n"; + return "????\n"; + } else { + return ""; + } + } + + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl::tl_type *type, + const tl::tl_combinator *t, int arity, bool is_function) const final { + if (is_header_ != (function_name == "enum" ? 1 : 0)) { + return ""; + } + + if (function_name == "TdDestroyObject" || function_name == "TdConvertToInternal" || + function_name == "TdStackStorer") { + auto class_name = gen_class_name(t->name); + std::string extra_arg = ""; + if (function_name == "TdStackStorer") { + extra_arg = ", M"; + } + return " case CODE_" + gen_class_name(t->name) + ": return " + function_name + " ((struct Td" + class_name + + " *)var" + extra_arg + ");\n"; + } else if (function_name == "TdConvertFromInternal") { + const tl::tl_tree_type *tree_type = static_cast(t->result); + + auto native_class_name = gen_native_class_name(t->name); + auto class_name = gen_main_class_name(tree_type->type); + if (type == nullptr) { + if (is_function) { + class_name = "Function"; + } else { + class_name = "Object"; + } + } + return " case CODE_" + gen_class_name(t->name) + ": return (struct Td" + class_name + " *)" + function_name + + "(static_cast(from));\n"; + } else if (function_name == "enum") { + const tl::tl_tree_type *tree_type = static_cast(t->result); + + auto native_class_name = gen_native_class_name(t->name); + auto class_name = gen_main_class_name(tree_type->type); + if (type == nullptr) { + if (is_function) { + class_name = "Function"; + } else { + class_name = "Object"; + } + } + + int flat = 0; + if (!is_function) { + if (tree_type->type->constructors_num == 1) { + flat = 1; + } + } + + if (class_name == "Object" && !flat) { + return " CODE_Copy_" + gen_class_name(t->name) + " = " + int_to_string(t->id) + ",\n"; + } else { + return " CODE_" + gen_class_name(t->name) + " = " + int_to_string(t->id) + ",\n"; + } + } else if (function_name == "TdStackFetcher") { + const tl::tl_tree_type *tree_type = static_cast(t->result); + + auto native_class_name = gen_native_class_name(t->name); + auto class_name = gen_main_class_name(tree_type->type); + if (type == nullptr) { + if (is_function) { + class_name = "Function"; + } else { + class_name = "Object"; + } + } + + return "if (constructor == \"" + gen_class_name(t->name) + + "\") {\n" + " return (struct Td" + + class_name + " *)TdStackFetcher" + gen_class_name(t->name) + + " (M);\n" + " }\n "; + } else { + return ""; + } + } + std::string gen_additional_proxy_function_end(const std::string &function_name, const tl::tl_type *type, + bool is_function) const final { + if (is_header_ != (function_name == "enum" ? 1 : 0)) { + return ""; + } + + if (function_name == "TdDestroyObject" || function_name == "TdConvertToInternal" || + function_name == "TdConvertFromInternal" || function_name == "TdStackStorer") { + std::string retval = ""; + if (function_name == "TdConvertToInternal" || function_name == "TdConvertFromInternal") { + retval = "nullptr"; + } + return " default:\n" + " LOG(FATAL) << \"Unknown constructor found \" << td::format::as_hex(constructor);\n" + " return " + + retval + + ";\n" + " }\n" + "}\n"; + } else if (function_name == "TdStackFetcher") { + return "{\n" + " LOG(FATAL) << \"Unknown constructor found \" << constructor;\n" + " return nullptr;\n" + " }\n" + "}\n"; + } else if (function_name == "enum") { + return "};\n"; + } else { + return ""; + } + } + + int get_additional_function_type(const std::string &additional_function_name) const final { + return 2; + } +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_cpp.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_cpp.h new file mode 100644 index 0000000000..35ace0cbd6 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_cpp.h @@ -0,0 +1,107 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "tl_writer_td.h" + +#include +#include +#include + +namespace td { + +class TD_TL_writer_cpp : public TD_TL_writer { + std::string gen_constructor_id_store_raw(const std::string &id) const; + + std::string gen_fetch_class_name(const tl::tl_tree_type *tree_type) const; + + std::string gen_full_fetch_class_name(const tl::tl_tree_type *tree_type) const; + + std::string gen_store_class_name(const tl::tl_tree_type *tree_type) const; + + std::string gen_full_store_class_name(const tl::tl_tree_type *tree_type) const; + + std::vector ext_include; + + protected: + std::string gen_vector_store(const std::string &field_name, const tl::tl_tree_type *t, + const std::vector &vars, int storer_type) const; + + virtual std::string get_pretty_field_name(std::string field_name) const; + + virtual std::string get_pretty_class_name(std::string class_name) const; + + public: + TD_TL_writer_cpp(const std::string &tl_name, const std::string &string_type, const std::string &bytes_type, + const std::vector &ext_include) + : TD_TL_writer(tl_name, string_type, bytes_type), ext_include(ext_include) { + } + + std::string gen_output_begin(const std::string &additional_imports) const override; + std::string gen_output_begin_once() const override; + std::string gen_output_end() const override; + + std::string gen_forward_class_declaration(const std::string &class_name, bool is_proxy) const override; + + std::string gen_class_begin(const std::string &class_name, const std::string &base_class_name, bool is_proxy, + const tl::tl_tree *result) const override; + std::string gen_class_end() const override; + + std::string gen_class_alias(const std::string &class_name, const std::string &alias_name) const override; + + std::string gen_field_definition(const std::string &class_name, const std::string &type_name, + const std::string &field_name) const override; + + std::string gen_vars(const tl::tl_combinator *t, const tl::tl_tree_type *result_type, + std::vector &vars) const override; + std::string gen_function_vars(const tl::tl_combinator *t, std::vector &vars) const override; + std::string gen_uni(const tl::tl_tree_type *result_type, std::vector &vars, + bool check_negative) const override; + std::string gen_constructor_id_store(std::int32_t id, int storer_type) const override; + + std::string gen_field_fetch(int field_num, const tl::arg &a, std::vector &vars, bool flat, + int parser_type) const override; + std::string gen_field_store(const tl::arg &a, const std::vector &args, + std::vector &vars, bool flat, int storer_type) const override; + std::string gen_type_fetch(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int parser_type) const override; + std::string gen_type_store(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int storer_type) const override; + std::string gen_var_type_fetch(const tl::arg &a) const override; + + std::string gen_get_id(const std::string &class_name, std::int32_t id, bool is_proxy) const override; + + std::string gen_function_result_type(const tl::tl_tree *result) const override; + + std::string gen_fetch_function_begin(const std::string &parser_name, const std::string &class_name, + const std::string &parent_class_name, int arity, int field_count, + std::vector &vars, int parser_type) const override; + std::string gen_fetch_function_end(bool has_parent, int field_count, const std::vector &vars, + int parser_type) const override; + + std::string gen_fetch_function_result_begin(const std::string &parser_name, const std::string &class_name, + const tl::tl_tree *result) const override; + std::string gen_fetch_function_result_end() const override; + std::string gen_fetch_function_result_any_begin(const std::string &parser_name, const std::string &class_name, + bool is_proxy) const override; + std::string gen_fetch_function_result_any_end(bool is_proxy) const override; + + std::string gen_store_function_begin(const std::string &storer_name, const std::string &class_name, int arity, + std::vector &vars, int storer_type) const override; + std::string gen_store_function_end(const std::vector &vars, int storer_type) const override; + + std::string gen_fetch_switch_begin() const override; + std::string gen_fetch_switch_case(const tl::tl_combinator *t, int arity) const override; + std::string gen_fetch_switch_end() const override; + + std::string gen_constructor_begin(int field_count, const std::string &class_name, bool is_default) const override; + std::string gen_constructor_field_init(int field_num, const std::string &class_name, const tl::arg &a, + bool is_default) const override; + std::string gen_constructor_end(const tl::tl_combinator *t, int field_count, bool is_default) const override; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_dotnet.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_dotnet.h new file mode 100644 index 0000000000..c12911b4d0 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_dotnet.h @@ -0,0 +1,582 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/tl/tl_writer.h" + +#include +#include +#include +#include +#include + +namespace td { +namespace tl { + +class TlWriterDotNet final : public TL_writer { + bool is_header_; + std::string prefix_; + + public: + TlWriterDotNet(const std::string &name, bool is_header, const std::string &prefix) + : TL_writer(name), is_header_(is_header), prefix_(prefix) { + } + + int get_max_arity() const final { + return 0; + } + + bool is_built_in_simple_type(const std::string &name) const final { + return name == "Bool" || name == "Int32" || name == "Int53" || name == "Int64" || name == "Double" || + name == "String" || name == "Bytes"; + } + bool is_built_in_complex_type(const std::string &name) const final { + return name == "Vector"; + } + bool is_type_bare(const tl_type *t) const final { + return t->simple_constructors <= 1 || (is_built_in_simple_type(t->name) && t->name != "Bool") || + is_built_in_complex_type(t->name); + } + + std::vector get_parsers() const final { + return {"FromUnmanaged"}; + } + int get_parser_type(const tl_combinator *t, const std::string &name) const final { + return 0; + } + Mode get_parser_mode(int type) const final { + return All; // Server; + } + std::vector get_storers() const final { + return {"ToUnmanaged", "ToString"}; + } + std::vector get_additional_functions() const final { + return {"ToUnmanaged", "FromUnmanaged"}; + } + int get_storer_type(const tl_combinator *t, const std::string &name) const final { + return name == "ToString"; + } + Mode get_storer_mode(int type) const final { + return type <= 1 ? All : Server; + } + + std::string gen_base_tl_class_name() const final { + return "BaseObject"; + } + std::string gen_base_type_class_name(int arity) const final { + assert(arity == 0); + return "Object"; + } + std::string gen_base_function_class_name() const final { + return "Function"; + } + + static std::string to_camelCase(const std::string &name) { + return to_cCamelCase(name, false); + } + static std::string to_CamelCase(const std::string &name) { + return to_cCamelCase(name, true); + } + static std::string to_cCamelCase(const std::string &name, bool flag) { + bool next_to_upper = flag; + std::string result; + for (std::size_t i = 0; i < name.size(); i++) { + if (!is_alnum(name[i])) { + next_to_upper = true; + continue; + } + if (next_to_upper) { + result += to_upper(name[i]); + next_to_upper = false; + } else { + result += name[i]; + } + } + return result; + } + + std::string gen_native_field_name(std::string name) const { + for (std::size_t i = 0; i < name.size(); i++) { + if (!is_alnum(name[i])) { + name[i] = '_'; + } + } + assert(name.size() > 0); + assert(name[name.size() - 1] != '_'); + return name + "_"; + } + + std::string gen_native_class_name(std::string name) const { + if (name == "Object") { + assert(0); + } + if (name == "#") { + return "int32_t"; + } + for (std::size_t i = 0; i < name.size(); i++) { + if (!is_alnum(name[i])) { + name[i] = '_'; + } + } + return name; + } + + std::string gen_class_name(std::string name) const final { + if (name == "Object" || name == "#") { + assert(0); + } + return to_CamelCase(name); + } + std::string gen_field_name(std::string name) const final { + assert(name.size() > 0); + assert(is_alnum(name.back())); + return to_CamelCase(name); + } + + std::string gen_type_name(const tl_tree_type *tree_type) const final { + const tl_type *t = tree_type->type; + const std::string &name = t->name; + + if (name == "#") { + assert(0); + } + if (name == "Bool") { + return "bool"; + } + if (name == "Int32") { + return "int32"; + } + if (name == "Int53" || name == "Int64") { + return "int64"; + } + if (name == "Double") { + return "float64"; + } + if (name == "String") { + return "String^"; + } + if (name == "Bytes") { + return "Array^"; + } + + if (name == "Vector") { + assert(t->arity == 1); + assert(tree_type->children.size() == 1); + assert(tree_type->children[0]->get_type() == NODE_TYPE_TYPE); + const tl_tree_type *child = static_cast(tree_type->children[0]); + + return "Array<" + gen_type_name(child) + ">^"; + } + + assert(!is_built_in_simple_type(name) && !is_built_in_complex_type(name)); + + for (std::size_t i = 0; i < tree_type->children.size(); i++) { + assert(tree_type->children[i]->get_type() == NODE_TYPE_NAT_CONST); + } + + return gen_main_class_name(t) + "^"; + } + + std::string gen_output_begin(const std::string &additional_imports) const final { + return prefix_ + "#include \"td/tl/tl_dotnet_object.h\"\n\n" + additional_imports + + "namespace Telegram {\n" + "namespace Td {\n" + "namespace Api {\n"; + } + + std::string gen_output_begin_once() const final { + return std::string(); + } + + std::string gen_output_end() const final { + return "}\n" + "}\n" + "}\n"; + } + + std::string gen_import_declaration(const std::string &name, bool is_system) const final { + if (is_system) { + return "#include <" + name + ">\n"; + } else { + return "#include \"" + name + "\"\n"; + } + } + + std::string gen_package_suffix() const final { + return ".h"; + } + + std::string gen_forward_class_declaration(const std::string &class_name, bool is_proxy) const final { + if (!is_header_) { + return ""; + } + std::stringstream ss; + ss << (is_proxy ? "interface" : "ref") << " class " << class_name << ";\n"; + return ss.str(); + } + + std::string gen_class_begin(const std::string &class_name, const std::string &base_class_name, bool is_proxy, + const tl::tl_tree *result) const final { + if (!is_header_) { + return ""; + } + + std::stringstream ss; + ss << "\npublic " << (is_proxy ? "interface" : "ref") << " class " << class_name << (is_proxy ? "" : " sealed") + << (class_name == gen_base_tl_class_name() ? "" : " : " + base_class_name) << " {\n" + << " public:\n"; + return ss.str(); + } + std::string gen_class_end() const final { + return ""; + } + + std::string gen_field_definition(const std::string &class_name, const std::string &type_name, + const std::string &field_name) const final { + if (!is_header_) { + return ""; + } + auto fixed_field_name = field_name; + if (field_name == class_name) { + fixed_field_name += "Value"; + } + auto is_web_page_stickers = + (class_name == "WebPage" && field_name == "Stickers" && type_name == "Array^"); + if (type_name == field_name + "^" || (type_name == "Message^" && field_name == "ReplyToMessage") || + is_web_page_stickers) { + auto fixed_type_name = + is_web_page_stickers ? "Array<::Telegram::Td::Api::Sticker^>^" : "::Telegram::Td::Api::" + type_name; + std::stringstream ss; + ss << "private:\n"; + ss << " " << fixed_type_name << " " << fixed_field_name << "PrivateField;\n"; + ss << "public:\n"; + ss << " property " << fixed_type_name << " " << fixed_field_name << " {\n"; + ss << " " << fixed_type_name << " get() {\n"; + ss << " return " << fixed_field_name << "PrivateField;\n"; + ss << " }\n"; + ss << " void set(" << fixed_type_name << " newValue) {\n"; + ss << " " << fixed_field_name << "PrivateField = newValue;\n"; + ss << " }\n"; + ss << " }\n"; + return ss.str(); + } + return " property " + type_name + " " + fixed_field_name + ";\n"; + } + + std::string gen_store_function_begin(const std::string &storer_name, const std::string &class_name, int arity, + std::vector &vars, int storer_type) const final { + if (storer_type < 0) { + return ""; + } + std::stringstream ss; + ss << "\n"; + if (storer_type) { + ss << (is_header_ ? " virtual " : "") << "String^ " << (is_header_ ? "" : gen_class_name(class_name) + "::") + << "ToString()" << (is_header_ ? " override;" : " {\n return ::Telegram::Td::Api::ToString(this);\n}") + << "\n"; + } else { + ss << (is_header_ ? " virtual " : "") << "NativeObject^ " + << (is_header_ ? "" : gen_class_name(class_name) + "::") << "ToUnmanaged()"; + if (is_header_) { + ss << ";\n"; + } else { + ss << " {\n return REF_NEW NativeObject(::Telegram::Td::Api::ToUnmanaged(this).release());\n}\n"; + } + } + return ss.str(); + } + std::string gen_store_function_end(const std::vector &vars, int storer_type) const final { + return ""; + } + + std::string gen_constructor_begin(int field_count, const std::string &class_name, bool is_default) const final { + std::stringstream ss; + ss << "\n"; + ss << (is_header_ ? " " : gen_class_name(class_name) + "::") << gen_class_name(class_name) << "("; + return ss.str(); + } + std::string gen_constructor_parameter(int field_num, const std::string &class_name, const arg &a, + bool is_default) const final { + if (is_default) { + return ""; + } + std::stringstream ss; + ss << (field_num == 0 ? "" : ", "); + auto field_type = gen_field_type(a); + auto pos = 0; + while (field_type.substr(pos, 6) == "Array<") { + pos += 6; + } + if (field_type.substr(pos, 4) != "BYTE" && field_type.substr(pos, 6) != "String" && + to_upper(field_type[pos]) == field_type[pos]) { + field_type = field_type.substr(0, pos) + "::Telegram::Td::Api::" + field_type.substr(pos); + } + ss << field_type << " " << to_camelCase(a.name); + return ss.str(); + } + std::string gen_constructor_field_init(int field_num, const std::string &class_name, const arg &a, + bool is_default) const final { + if (is_default || is_header_) { + return ""; + } + + std::stringstream ss; + if (field_num == 0) { + ss << ") {\n"; + } + auto field_name = gen_field_name(a.name); + if (field_name == class_name) { + field_name += "Value"; + } + ss << " " << field_name << " = " << to_camelCase(a.name) << ";\n"; + + return ss.str(); + } + std::string gen_constructor_end(const tl_combinator *t, int field_count, bool is_default) const final { + if (is_header_) { + return ");\n"; + } + std::stringstream ss; + if (field_count == 0) { + ss << ") {\n"; + } + ss << "}\n"; + return ss.str(); + } + std::string gen_additional_function(const std::string &function_name, const tl_combinator *t, + bool is_function) const final { + std::stringstream ss; + if (is_header_ && function_name == "ToUnmanaged") { + ss << "};\n"; + } + ss << "\n"; + if (function_name == "ToUnmanaged") { + gen_to_unmanaged(ss, t); + } else { + gen_from_unmanaged(ss, t); + } + return ss.str(); + } + void gen_to_unmanaged(std::stringstream &ss, const tl_combinator *t) const { + auto native_class_name = gen_native_class_name(t->name); + auto class_name = gen_class_name(t->name); + ss << "td::td_api::object_ptr ToUnmanaged(" << class_name << "^ from)"; + if (is_header_) { + ss << ";\n"; + return; + } + ss << " {\n" + << " if (!from) {\n" + << " return nullptr;\n" + << " }\n" + << " return td::td_api::make_object("; + bool is_first = true; + for (auto &it : t->args) { + if (is_first) { + is_first = false; + } else { + ss << ", "; + } + auto field_name = gen_field_name(it.name); + if (field_name == class_name) { + field_name += "Value"; + } + ss << "ToUnmanaged(from->" << field_name << ")"; + } + ss << ");\n}\n"; + } + + void gen_from_unmanaged(std::stringstream &ss, const tl_combinator *t) const { + auto native_class_name = gen_native_class_name(t->name); + auto class_name = gen_class_name(t->name); + ss << class_name << "^ FromUnmanaged(td::td_api::" << native_class_name << " &from)"; + if (is_header_) { + ss << ";\n"; + return; + } + ss << " {\n" + << " return REF_NEW " << class_name << "("; + bool is_first = true; + for (auto &it : t->args) { + if (is_first) { + is_first = false; + } else { + ss << ", "; + } + bool need_bytes = gen_field_type(it) == "Array^" || gen_field_type(it) == "Array^>^"; + ss << (need_bytes ? "Bytes" : "") << "FromUnmanaged(from." << gen_native_field_name(it.name) << ")"; + } + ss << ");\n}\n"; + } + + std::string gen_array_type_name(const tl_tree_array *arr, const std::string &field_name) const final { + assert(0); + return std::string(); + } + std::string gen_var_type_name() const final { + assert(0); + return std::string(); + } + + std::string gen_int_const(const tl_tree *tree_c, const std::vector &vars) const final { + assert(0); + return std::string(); + } + + std::string gen_var_name(const var_description &desc) const final { + assert(0); + return ""; + } + std::string gen_parameter_name(int index) const final { + assert(0); + return ""; + } + + std::string gen_class_alias(const std::string &class_name, const std::string &alias_name) const final { + return ""; + } + + std::string gen_vars(const tl_combinator *t, const tl_tree_type *result_type, + std::vector &vars) const final { + assert(vars.empty()); + return ""; + } + std::string gen_function_vars(const tl_combinator *t, std::vector &vars) const final { + assert(vars.empty()); + return ""; + } + std::string gen_uni(const tl_tree_type *result_type, std::vector &vars, + bool check_negative) const final { + assert(result_type->children.empty()); + return ""; + } + std::string gen_constructor_id_store(std::int32_t id, int storer_type) const final { + return ""; + } + std::string gen_field_fetch(int field_num, const arg &a, std::vector &vars, bool flat, + int parser_type) const final { + return ""; + // std::stringstream ss; + // ss << gen_field_name(a.name) << " = from_unmanaged(from->" << + // gen_native_field_name(a.name) << ");\n"; return ss.str(); + } + std::string gen_field_store(const arg &a, const std::vector &args, std::vector &vars, + bool flat, int storer_type) const final { + return ""; + // std::stringstream ss; + // ss << "to_unmanaged(" << gen_field_name(a.name) << ")"; + // return ss.str(); + } + std::string gen_type_fetch(const std::string &field_name, const tl_tree_type *tree_type, + const std::vector &vars, int parser_type) const final { + assert(vars.empty()); + return ""; + } + + std::string gen_type_store(const std::string &field_name, const tl_tree_type *tree_type, + const std::vector &vars, int storer_type) const final { + return ""; + } + std::string gen_var_type_fetch(const arg &a) const final { + assert(0); + return ""; + } + + std::string gen_get_id(const std::string &class_name, std::int32_t id, bool is_proxy) const final { + return ""; + } + + std::string gen_function_result_type(const tl_tree *result) const final { + return ""; + } + + std::string gen_fetch_function_begin(const std::string &parser_name, const std::string &class_name, + const std::string &parent_class_name, int arity, int field_count, + std::vector &vars, int parser_type) const final { + return ""; + } + std::string gen_fetch_function_end(bool has_parent, int field_count, const std::vector &vars, + int parser_type) const final { + return ""; + } + + std::string gen_fetch_function_result_begin(const std::string &parser_name, const std::string &class_name, + const tl_tree *result) const final { + return ""; + } + std::string gen_fetch_function_result_end() const final { + return ""; + } + std::string gen_fetch_function_result_any_begin(const std::string &parser_name, const std::string &class_name, + bool is_proxy) const final { + return ""; + } + std::string gen_fetch_function_result_any_end(bool is_proxy) const final { + return ""; + } + + std::string gen_fetch_switch_begin() const final { + return ""; + } + std::string gen_fetch_switch_case(const tl_combinator *t, int arity) const final { + return ""; + } + std::string gen_fetch_switch_end() const final { + return ""; + } + + std::string gen_additional_proxy_function_begin(const std::string &function_name, const tl_type *type, + const std::string &name, int arity, bool is_function) const final { + std::stringstream ss; + if (is_header_ && function_name == "ToUnmanaged") { + ss << "};\n"; + } + if (type == nullptr) { + return ss.str(); + } + auto native_class_name = gen_native_class_name(type->name); + auto class_name = gen_class_name(type->name); + if (function_name == "ToUnmanaged") { + ss << "td::td_api::object_ptr ToUnmanaged(" << class_name << "^ from)"; + if (is_header_) { + ss << ";\n"; + return ss.str(); + } + ss << " {\n" + << " if (!from) {\n" + << " return nullptr;\n" + << " }\n" + << " return td::td_api::move_object_as(from->ToUnmanaged()->get_object_ptr());\n}\n"; + } else { + ss << class_name << "^ FromUnmanaged(td::td_api::" << native_class_name << " &from)"; + if (is_header_) { + ss << ";\n"; + return ss.str(); + } + ss << " {\n"; + ss << " return DoFromUnmanaged<" << class_name << "^>(from);\n"; + ss << "}\n"; + } + return ss.str(); + } + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl_type *type, + const std::string &class_name, int arity) const final { + return ""; + } + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl_type *type, + const tl_combinator *t, int arity, bool is_function) const final { + return ""; + } + std::string gen_additional_proxy_function_end(const std::string &function_name, const tl_type *type, + bool is_function) const final { + return ""; + } +}; + +} // namespace tl +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_h.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_h.h new file mode 100644 index 0000000000..e9e39fc377 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_h.h @@ -0,0 +1,95 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "tl_writer_td.h" + +#include +#include +#include + +namespace td { + +class TD_TL_writer_h : public TD_TL_writer { + protected: + const std::vector ext_include; + + static std::string forward_declaration(std::string type); + + bool need_arg_mask(const tl::arg &a, bool can_be_stored) const; + + public: + TD_TL_writer_h(const std::string &tl_name, const std::string &string_type, const std::string &bytes_type, + const std::vector &ext_include) + : TD_TL_writer(tl_name, string_type, bytes_type), ext_include(ext_include) { + } + + std::string gen_output_begin(const std::string &additional_imports) const override; + std::string gen_output_begin_once() const override; + std::string gen_output_end() const override; + + std::string gen_forward_class_declaration(const std::string &class_name, bool is_proxy) const override; + + std::string gen_class_begin(const std::string &class_name, const std::string &base_class_name, bool is_proxy, + const tl::tl_tree *result) const override; + std::string gen_class_end() const override; + + std::string gen_class_alias(const std::string &class_name, const std::string &alias_name) const override; + + std::string gen_field_definition(const std::string &class_name, const std::string &type_name, + const std::string &field_name) const override; + + std::string gen_flags_definitions(const tl::tl_combinator *t, bool can_be_stored) const override; + std::string gen_vars(const tl::tl_combinator *t, const tl::tl_tree_type *result_type, + std::vector &vars) const override; + std::string gen_function_vars(const tl::tl_combinator *t, std::vector &vars) const override; + std::string gen_uni(const tl::tl_tree_type *result_type, std::vector &vars, + bool check_negative) const override; + std::string gen_constructor_id_store(std::int32_t id, int storer_type) const override; + + std::string gen_field_fetch(int field_num, const tl::arg &a, std::vector &vars, bool flat, + int parser_type) const override; + std::string gen_field_store(const tl::arg &a, const std::vector &args, + std::vector &vars, bool flat, int storer_type) const override; + std::string gen_type_fetch(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int parser_type) const override; + std::string gen_type_store(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int storer_type) const override; + std::string gen_var_type_fetch(const tl::arg &a) const override; + + std::string gen_get_id(const std::string &class_name, std::int32_t id, bool is_proxy) const override; + + std::string gen_function_result_type(const tl::tl_tree *result) const override; + + std::string gen_fetch_function_begin(const std::string &parser_name, const std::string &class_name, + const std::string &parent_class_name, int arity, int field_count, + std::vector &vars, int parser_type) const override; + std::string gen_fetch_function_end(bool has_parent, int field_count, const std::vector &vars, + int parser_type) const override; + + std::string gen_fetch_function_result_begin(const std::string &parser_name, const std::string &class_name, + const tl::tl_tree *result) const override; + std::string gen_fetch_function_result_end() const override; + std::string gen_fetch_function_result_any_begin(const std::string &parser_name, const std::string &class_name, + bool is_proxy) const override; + std::string gen_fetch_function_result_any_end(bool is_proxy) const override; + + std::string gen_store_function_begin(const std::string &storer_name, const std::string &class_name, int arity, + std::vector &vars, int storer_type) const override; + std::string gen_store_function_end(const std::vector &vars, int storer_type) const override; + + std::string gen_fetch_switch_begin() const override; + std::string gen_fetch_switch_case(const tl::tl_combinator *t, int arity) const override; + std::string gen_fetch_switch_end() const override; + + std::string gen_constructor_begin(int field_count, const std::string &class_name, bool is_default) const override; + std::string gen_constructor_field_init(int field_num, const std::string &class_name, const tl::arg &a, + bool is_default) const override; + std::string gen_constructor_end(const tl::tl_combinator *t, int field_count, bool is_default) const override; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_hpp.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_hpp.h new file mode 100644 index 0000000000..26165ae1b6 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_hpp.h @@ -0,0 +1,108 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "tl_writer_td.h" + +#include +#include +#include + +namespace td { + +class TD_TL_writer_hpp final : public TD_TL_writer { + public: + TD_TL_writer_hpp(const std::string &tl_name, const std::string &string_type, const std::string &bytes_type) + : TD_TL_writer(tl_name, string_type, bytes_type) { + } + + bool is_documentation_generated() const final; + + int get_additional_function_type(const std::string &additional_function_name) const final; + std::vector get_additional_functions() const final; + + std::string gen_base_type_class_name(int arity) const final; + std::string gen_base_tl_class_name() const final; + + std::string gen_output_begin(const std::string &additional_imports) const final; + std::string gen_output_begin_once() const final; + std::string gen_output_end() const final; + + std::string gen_forward_class_declaration(const std::string &class_name, bool is_proxy) const final; + + std::string gen_class_begin(const std::string &class_name, const std::string &base_class_name, bool is_proxy, + const tl::tl_tree *result) const final; + std::string gen_class_end() const final; + + std::string gen_class_alias(const std::string &class_name, const std::string &alias_name) const final; + + std::string gen_field_definition(const std::string &class_name, const std::string &type_name, + const std::string &field_name) const final; + + std::string gen_vars(const tl::tl_combinator *t, const tl::tl_tree_type *result_type, + std::vector &vars) const final; + std::string gen_function_vars(const tl::tl_combinator *t, std::vector &vars) const final; + std::string gen_uni(const tl::tl_tree_type *result_type, std::vector &vars, + bool check_negative) const final; + std::string gen_constructor_id_store(std::int32_t id, int storer_type) const final; + + std::string gen_field_fetch(int field_num, const tl::arg &a, std::vector &vars, bool flat, + int parser_type) const final; + std::string gen_field_store(const tl::arg &a, const std::vector &args, + std::vector &vars, bool flat, int storer_type) const final; + std::string gen_type_fetch(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int parser_type) const final; + std::string gen_type_store(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int storer_type) const final; + std::string gen_var_type_fetch(const tl::arg &a) const final; + + std::string gen_get_id(const std::string &class_name, std::int32_t id, bool is_proxy) const final; + + std::string gen_function_result_type(const tl::tl_tree *result) const final; + + std::string gen_fetch_function_begin(const std::string &parser_name, const std::string &class_name, + const std::string &parent_class_name, int arity, int field_count, + std::vector &vars, int parser_type) const final; + std::string gen_fetch_function_end(bool has_parent, int field_count, const std::vector &vars, + int parser_type) const final; + + std::string gen_fetch_function_result_begin(const std::string &parser_name, const std::string &class_name, + const tl::tl_tree *result) const final; + std::string gen_fetch_function_result_end() const final; + std::string gen_fetch_function_result_any_begin(const std::string &parser_name, const std::string &class_name, + bool is_proxy) const final; + std::string gen_fetch_function_result_any_end(bool is_proxy) const final; + + std::string gen_store_function_begin(const std::string &storer_name, const std::string &class_name, int arity, + std::vector &vars, int storer_type) const final; + std::string gen_store_function_end(const std::vector &vars, int storer_type) const final; + + std::string gen_fetch_switch_begin() const final; + std::string gen_fetch_switch_case(const tl::tl_combinator *t, int arity) const final; + std::string gen_fetch_switch_end() const final; + + std::string gen_constructor_begin(int field_count, const std::string &class_name, bool is_default) const final; + std::string gen_constructor_parameter(int field_num, const std::string &class_name, const tl::arg &a, + bool is_default) const final; + std::string gen_constructor_field_init(int field_num, const std::string &class_name, const tl::arg &a, + bool is_default) const final; + std::string gen_constructor_end(const tl::tl_combinator *t, int field_count, bool is_default) const final; + + std::string gen_additional_function(const std::string &function_name, const tl::tl_combinator *t, + bool is_function) const final; + std::string gen_additional_proxy_function_begin(const std::string &function_name, const tl::tl_type *type, + const std::string &class_name, int arity, + bool is_function) const final; + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl::tl_type *type, + const std::string &class_name, int arity) const final; + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl::tl_type *type, + const tl::tl_combinator *t, int arity, bool is_function) const final; + std::string gen_additional_proxy_function_end(const std::string &function_name, const tl::tl_type *type, + bool is_function) const final; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_java.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_java.h new file mode 100644 index 0000000000..94a602d921 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_java.h @@ -0,0 +1,124 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/tl/tl_writer.h" + +#include +#include +#include + +namespace td { + +class TD_TL_writer_java final : public tl::TL_writer { + static const int MAX_ARITY = 0; + + static const std::string base_type_class_names[MAX_ARITY + 1]; + static const std::string base_tl_class_name; + static const std::string base_function_class_name; + + const std::string package_name; + + public: + TD_TL_writer_java(const std::string &tl_name, const std::string &package_name) + : TL_writer(tl_name), package_name(package_name) { + } + + int get_max_arity() const final; + + bool is_built_in_simple_type(const std::string &name) const final; + bool is_built_in_complex_type(const std::string &name) const final; + bool is_type_bare(const tl::tl_type *t) const final; + bool is_combinator_supported(const tl::tl_combinator *constructor) const final; + + int get_parser_type(const tl::tl_combinator *t, const std::string &parser_name) const final; + int get_storer_type(const tl::tl_combinator *t, const std::string &storer_name) const final; + std::vector get_parsers() const final; + std::vector get_storers() const final; + + std::string gen_base_tl_class_name() const final; + std::string gen_base_type_class_name(int arity) const final; + std::string gen_base_function_class_name() const final; + std::string gen_class_name(std::string name) const final; + std::string gen_field_name(std::string name) const final; + std::string gen_var_name(const tl::var_description &desc) const final; + std::string gen_parameter_name(int index) const final; + std::string gen_type_name(const tl::tl_tree_type *tree_type) const final; + std::string gen_array_type_name(const tl::tl_tree_array *arr, const std::string &field_name) const final; + std::string gen_var_type_name() const final; + + std::string gen_int_const(const tl::tl_tree *tree_c, const std::vector &vars) const final; + + std::string gen_output_begin(const std::string &additional_imports) const final; + std::string gen_output_begin_once() const final; + std::string gen_output_end() const final; + + std::string gen_import_declaration(const std::string &name, bool is_system) const final; + + std::string gen_package_suffix() const final; + + std::string gen_forward_class_declaration(const std::string &class_name, bool is_proxy) const final; + + std::string gen_class_begin(const std::string &class_name, const std::string &base_class_name, bool is_proxy, + const tl::tl_tree *result) const final; + std::string gen_class_end() const final; + + std::string gen_class_alias(const std::string &class_name, const std::string &alias_name) const final; + + std::string gen_field_definition(const std::string &class_name, const std::string &type_name, + const std::string &field_name) const final; + + std::string gen_vars(const tl::tl_combinator *t, const tl::tl_tree_type *result_type, + std::vector &vars) const final; + std::string gen_function_vars(const tl::tl_combinator *t, std::vector &vars) const final; + std::string gen_uni(const tl::tl_tree_type *result_type, std::vector &vars, + bool check_negative) const final; + std::string gen_constructor_id_store(std::int32_t id, int storer_type) const final; + std::string gen_field_fetch(int field_num, const tl::arg &a, std::vector &vars, bool flat, + int parser_type) const final; + std::string gen_field_store(const tl::arg &a, const std::vector &args, + std::vector &vars, bool flat, int storer_type) const final; + std::string gen_type_fetch(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int parser_type) const final; + std::string gen_type_store(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int storer_type) const final; + std::string gen_var_type_fetch(const tl::arg &a) const final; + + std::string gen_get_id(const std::string &class_name, std::int32_t id, bool is_proxy) const final; + + std::string gen_function_result_type(const tl::tl_tree *result) const final; + + std::string gen_fetch_function_begin(const std::string &parser_name, const std::string &class_name, + const std::string &parent_class_name, int arity, int field_count, + std::vector &vars, int parser_type) const final; + std::string gen_fetch_function_end(bool has_parent, int field_count, const std::vector &vars, + int parser_type) const final; + + std::string gen_fetch_function_result_begin(const std::string &parser_name, const std::string &class_name, + const tl::tl_tree *result) const final; + std::string gen_fetch_function_result_end() const final; + std::string gen_fetch_function_result_any_begin(const std::string &parser_name, const std::string &class_name, + bool is_proxy) const final; + std::string gen_fetch_function_result_any_end(bool is_proxy) const final; + + std::string gen_store_function_begin(const std::string &storer_name, const std::string &class_name, int arity, + std::vector &vars, int storer_type) const final; + std::string gen_store_function_end(const std::vector &vars, int storer_type) const final; + + std::string gen_fetch_switch_begin() const final; + std::string gen_fetch_switch_case(const tl::tl_combinator *t, int arity) const final; + std::string gen_fetch_switch_end() const final; + + std::string gen_constructor_begin(int field_count, const std::string &class_name, bool is_default) const final; + std::string gen_constructor_parameter(int field_num, const std::string &class_name, const tl::arg &a, + bool is_default) const final; + std::string gen_constructor_field_init(int field_num, const std::string &class_name, const tl::arg &a, + bool is_default) const final; + std::string gen_constructor_end(const tl::tl_combinator *t, int field_count, bool is_default) const final; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_jni_cpp.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_jni_cpp.h new file mode 100644 index 0000000000..3d7cb0d25e --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_jni_cpp.h @@ -0,0 +1,109 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "tl_writer_cpp.h" + +#include +#include +#include +#include + +namespace td { + +class TD_TL_writer_jni_cpp final : public TD_TL_writer_cpp { + std::string gen_output_begin_once() const final; + + std::string gen_vector_fetch(std::string field_name, const tl::tl_tree_type *t, + const std::vector &vars, int parser_type) const; + + std::string gen_vector_store(const std::string &field_name, const tl::tl_tree_type *t, + const std::vector &vars, int storer_type) const; + + std::string gen_java_field_name(std::string name) const; + + std::string gen_basic_java_class_name(std::string name) const; + + std::string gen_java_class_name(std::string name) const; + + std::string gen_type_signature(const tl::tl_tree_type *tree_type) const; + + std::string get_pretty_field_name(std::string field_name) const final; + + std::string get_pretty_class_name(std::string class_name) const final; + + public: + TD_TL_writer_jni_cpp(const std::string &tl_name, const std::string &string_type, const std::string &bytes_type, + const std::vector &ext_include) + : TD_TL_writer_cpp(tl_name, string_type, bytes_type, ext_include) { + } + + bool is_built_in_simple_type(const std::string &name) const final; + bool is_built_in_complex_type(const std::string &name) const final; + + int get_parser_type(const tl::tl_combinator *t, const std::string &parser_name) const final; + int get_additional_function_type(const std::string &additional_function_name) const final; + std::vector get_parsers() const final; + std::vector get_storers() const final; + std::vector get_additional_functions() const final; + + std::string gen_base_type_class_name(int arity) const final; + std::string gen_base_tl_class_name() const final; + + std::string gen_class_begin(const std::string &class_name, const std::string &base_class_name, bool is_proxy, + const tl::tl_tree *result) const final; + + std::string gen_field_definition(const std::string &class_name, const std::string &type_name, + const std::string &field_name) const final; + + std::string gen_constructor_id_store(std::int32_t id, int storer_type) const final; + + std::string gen_field_fetch(int field_num, const tl::arg &a, std::vector &vars, bool flat, + int parser_type) const final; + std::string gen_field_store(const tl::arg &a, const std::vector &args, + std::vector &vars, bool flat, int storer_type) const final; + std::string gen_type_fetch(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int parser_type) const final; + std::string gen_type_store(const std::string &field_name, const tl::tl_tree_type *tree_type, + const std::vector &vars, int storer_type) const final; + + std::string gen_get_id(const std::string &class_name, std::int32_t id, bool is_proxy) const final; + + std::string gen_fetch_function_begin(const std::string &parser_name, const std::string &class_name, + const std::string &parent_class_name, int arity, int field_count, + std::vector &vars, int parser_type) const final; + std::string gen_fetch_function_end(bool has_parent, int field_count, const std::vector &vars, + int parser_type) const final; + + std::string gen_fetch_function_result_begin(const std::string &parser_name, const std::string &class_name, + const tl::tl_tree *result) const final; + std::string gen_fetch_function_result_end() const final; + std::string gen_fetch_function_result_any_begin(const std::string &parser_name, const std::string &class_name, + bool is_proxy) const final; + std::string gen_fetch_function_result_any_end(bool is_proxy) const final; + + std::string gen_store_function_begin(const std::string &storer_name, const std::string &class_name, int arity, + std::vector &vars, int storer_type) const final; + + std::string gen_fetch_switch_begin() const final; + std::string gen_fetch_switch_case(const tl::tl_combinator *t, int arity) const final; + std::string gen_fetch_switch_end() const final; + + std::string gen_additional_function(const std::string &function_name, const tl::tl_combinator *t, + bool is_function) const final; + std::string gen_additional_proxy_function_begin(const std::string &function_name, const tl::tl_type *type, + const std::string &class_name, int arity, + bool is_function) const final; + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl::tl_type *type, + const std::string &class_name, int arity) const final; + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl::tl_type *type, + const tl::tl_combinator *t, int arity, bool is_function) const final; + std::string gen_additional_proxy_function_end(const std::string &function_name, const tl::tl_type *type, + bool is_function) const final; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_jni_h.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_jni_h.h new file mode 100644 index 0000000000..a501b53cfa --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_jni_h.h @@ -0,0 +1,57 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "tl_writer_h.h" + +#include +#include + +namespace td { + +class TD_TL_writer_jni_h final : public TD_TL_writer_h { + public: + TD_TL_writer_jni_h(const std::string &tl_name, const std::string &string_type, const std::string &bytes_type, + const std::vector &ext_include) + : TD_TL_writer_h(tl_name, string_type, bytes_type, ext_include) { + } + + bool is_built_in_simple_type(const std::string &name) const final; + bool is_built_in_complex_type(const std::string &name) const final; + + int get_parser_type(const tl::tl_combinator *t, const std::string &parser_name) const final; + int get_additional_function_type(const std::string &additional_function_name) const final; + std::vector get_parsers() const final; + std::vector get_storers() const final; + std::vector get_additional_functions() const final; + + std::string gen_base_type_class_name(int arity) const final; + std::string gen_base_tl_class_name() const final; + + std::string gen_output_begin(const std::string &additional_imports) const final; + std::string gen_output_begin_once() const final; + + std::string gen_class_begin(const std::string &class_name, const std::string &base_class_name, bool is_proxy, + const tl::tl_tree *result) const final; + + std::string gen_field_definition(const std::string &class_name, const std::string &type_name, + const std::string &field_name) const final; + + std::string gen_additional_function(const std::string &function_name, const tl::tl_combinator *t, + bool is_function) const final; + std::string gen_additional_proxy_function_begin(const std::string &function_name, const tl::tl_type *type, + const std::string &class_name, int arity, + bool is_function) const final; + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl::tl_type *type, + const std::string &class_name, int arity) const final; + std::string gen_additional_proxy_function_case(const std::string &function_name, const tl::tl_type *type, + const tl::tl_combinator *t, int arity, bool is_function) const final; + std::string gen_additional_proxy_function_end(const std::string &function_name, const tl::tl_type *type, + bool is_function) const final; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_td.h b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_td.h new file mode 100644 index 0000000000..6eab3086e6 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/generate/tl_writer_td.h @@ -0,0 +1,67 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/tl/tl_writer.h" + +#include +#include + +namespace td { + +class TD_TL_writer : public tl::TL_writer { + static const int MAX_ARITY = 0; + + static const std::string base_type_class_names[MAX_ARITY + 1]; + static const std::string base_tl_class_name; + static const std::string base_function_class_name; + + protected: + const std::string string_type; + const std::string bytes_type; + + public: + TD_TL_writer(const std::string &tl_name, const std::string &string_type, const std::string &bytes_type) + : TL_writer(tl_name), string_type(string_type), bytes_type(bytes_type) { + } + + int get_max_arity() const override; + + bool is_built_in_simple_type(const std::string &name) const override; + bool is_built_in_complex_type(const std::string &name) const override; + bool is_type_bare(const tl::tl_type *t) const override; + bool is_combinator_supported(const tl::tl_combinator *constructor) const override; + bool is_default_constructor_generated(const tl::tl_combinator *t, bool can_be_parsed, + bool can_be_stored) const override; + bool is_full_constructor_generated(const tl::tl_combinator *t, bool can_be_parsed, bool can_be_stored) const override; + + int get_storer_type(const tl::tl_combinator *t, const std::string &storer_name) const override; + Mode get_parser_mode(int type) const override; + Mode get_storer_mode(int type) const override; + std::vector get_parsers() const override; + std::vector get_storers() const override; + + std::string gen_import_declaration(const std::string &package_name, bool is_system) const override; + std::string gen_package_suffix() const override; + std::string gen_base_tl_class_name() const override; + std::string gen_base_type_class_name(int arity) const override; + std::string gen_base_function_class_name() const override; + std::string gen_class_name(std::string name) const override; + std::string gen_field_name(std::string name) const override; + std::string gen_var_name(const tl::var_description &desc) const override; + std::string gen_parameter_name(int index) const override; + std::string gen_type_name(const tl::tl_tree_type *tree_type) const override; + std::string gen_array_type_name(const tl::tl_tree_array *arr, const std::string &field_name) const override; + std::string gen_var_type_name() const override; + + std::string gen_int_const(const tl::tl_tree *tree_c, const std::vector &vars) const override; + + std::string gen_constructor_parameter(int field_num, const std::string &class_name, const tl::arg &a, + bool is_default) const override; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/AuthData.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/AuthData.h new file mode 100644 index 0000000000..d7458a6f4b --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/AuthData.h @@ -0,0 +1,295 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/AuthKey.h" +#include "td/mtproto/MessageId.h" + +#include "td/utils/common.h" +#include "td/utils/Slice.h" +#include "td/utils/Status.h" + +#include + +namespace td { +namespace mtproto { + +struct ServerSalt { + int64 salt; + double valid_since; + double valid_until; +}; + +template +void store(const ServerSalt &salt, StorerT &storer) { + storer.template store_binary(salt.salt); + storer.template store_binary(salt.valid_since); + storer.template store_binary(salt.valid_until); +} + +template +void parse(ServerSalt &salt, ParserT &parser) { + salt.salt = parser.fetch_long(); + salt.valid_since = parser.fetch_double(); + salt.valid_until = parser.fetch_double(); +} + +Status check_message_id_duplicates(MessageId *saved_message_ids, size_t max_size, size_t &end_pos, + MessageId message_id); + +template +class MessageIdDuplicateChecker { + public: + Status check(MessageId message_id) { + return check_message_id_duplicates(&saved_message_ids_[0], max_size, end_pos_, message_id); + } + + private: + std::array saved_message_ids_; + size_t end_pos_ = 0; +}; + +class AuthData { + public: + AuthData(); + AuthData(const AuthData &) = default; + AuthData &operator=(const AuthData &) = delete; + AuthData(AuthData &&) = delete; + AuthData &operator=(AuthData &&) = delete; + ~AuthData() = default; + + bool is_ready(double now); + + void set_main_auth_key(AuthKey auth_key) { + main_auth_key_ = std::move(auth_key); + } + void break_main_auth_key() { + main_auth_key_.break_key(); + } + const AuthKey &get_main_auth_key() const { + // CHECK(has_main_auth_key()); + return main_auth_key_; + } + bool has_main_auth_key() const { + return !main_auth_key_.empty(); + } + bool need_main_auth_key() const { + return !has_main_auth_key(); + } + + void set_tmp_auth_key(AuthKey auth_key) { + CHECK(!auth_key.empty()); + tmp_auth_key_ = std::move(auth_key); + } + const AuthKey &get_tmp_auth_key() const { + return tmp_auth_key_; + } + bool was_tmp_auth_key() const { + return use_pfs() && !tmp_auth_key_.empty(); + } + bool need_tmp_auth_key(double now, double refresh_margin) const { + if (!use_pfs()) { + return false; + } + if (tmp_auth_key_.empty()) { + return true; + } + if (now > tmp_auth_key_.expires_at() - refresh_margin) { + return true; + } + return false; + } + void drop_main_auth_key() { + main_auth_key_ = AuthKey(); + } + void drop_tmp_auth_key() { + tmp_auth_key_ = AuthKey(); + } + bool has_tmp_auth_key(double now) const { + if (!use_pfs()) { + return false; + } + if (tmp_auth_key_.empty()) { + return false; + } + if (now > tmp_auth_key_.expires_at()) { + return false; + } + return true; + } + + const AuthKey &get_auth_key() const { + if (use_pfs()) { + return get_tmp_auth_key(); + } + return get_main_auth_key(); + } + bool has_auth_key(double now) const { + if (use_pfs()) { + return has_tmp_auth_key(now); + } + return has_main_auth_key(); + } + + bool get_auth_flag() const { + return main_auth_key_.auth_flag(); + } + void set_auth_flag(bool auth_flag) { + main_auth_key_.set_auth_flag(auth_flag); + if (!auth_flag) { + drop_tmp_auth_key(); + } + } + + bool get_bind_flag() const { + return !use_pfs() || tmp_auth_key_.auth_flag(); + } + void on_bind() { + CHECK(use_pfs()); + tmp_auth_key_.set_auth_flag(true); + } + + Slice get_header() const { + if (use_pfs()) { + return tmp_auth_key_.need_header() ? Slice(header_) : Slice(); + } else { + return main_auth_key_.need_header() ? Slice(header_) : Slice(); + } + } + + void set_header(std::string header) { + header_ = std::move(header); + } + + void on_api_response() { + if (use_pfs()) { + tmp_auth_key_.remove_header(); + } else { + main_auth_key_.remove_header(); + } + } + + void on_connection_not_inited() { + if (use_pfs()) { + tmp_auth_key_.restore_header(); + } else { + main_auth_key_.restore_header(); + } + } + + void set_session_id(uint64 session_id) { + session_id_ = session_id; + } + uint64 get_session_id() const { + CHECK(session_id_ != 0); + return session_id_; + } + + double get_server_time(double now) const { + return server_time_difference_ + now; + } + + double get_server_time_difference() const { + return server_time_difference_; + } + + // diff == msg_id / 2^32 - now == old_server_now - now <= server_now - now + // server_time_difference >= max{diff} + bool update_server_time_difference(double diff); + + void reset_server_time_difference(double diff); + + uint64 get_server_salt(double now) { + update_salt(now); + return server_salt_.salt; + } + + void set_server_salt(uint64 salt, double now) { + server_salt_.salt = salt; + double server_time = get_server_time(now); + server_salt_.valid_since = server_time; + server_salt_.valid_until = server_time + 60 * 10; + future_salts_.clear(); + } + + bool is_server_salt_valid(double now) const { + return server_salt_.valid_until > get_server_time(now) + 60; + } + + bool has_salt(double now) { + update_salt(now); + return is_server_salt_valid(now); + } + + bool need_future_salts(double now) { + update_salt(now); + return future_salts_.empty() || !is_server_salt_valid(now); + } + + void set_future_salts(const std::vector &salts, double now); + + std::vector get_future_salts() const; + + MessageId next_message_id(double now); + + bool is_valid_outbound_msg_id(MessageId message_id, double now) const; + + bool is_valid_inbound_msg_id(MessageId message_id, double now) const; + + Status check_packet(uint64 session_id, MessageId message_id, double now, bool &time_difference_was_updated); + + Status check_update(MessageId message_id) { + return updates_duplicate_checker_.check(message_id); + } + + Status recheck_update(MessageId message_id) { + return updates_duplicate_rechecker_.check(message_id); + } + + int32 next_seq_no(bool is_content_related) { + int32 res = seq_no_; + if (is_content_related) { + res |= 1; + seq_no_ += 2; + } + return res; + } + + void clear_seq_no() { + seq_no_ = 0; + } + + void set_use_pfs(bool use_pfs) { + use_pfs_ = use_pfs; + } + bool use_pfs() const { + return use_pfs_; + } + + private: + bool use_pfs_ = true; + AuthKey main_auth_key_; + AuthKey tmp_auth_key_; + bool server_time_difference_was_updated_ = false; + double server_time_difference_ = 0; + ServerSalt server_salt_; + MessageId last_message_id_; + int32 seq_no_ = 0; + string header_; + uint64 session_id_ = 0; + + std::vector future_salts_; + + MessageIdDuplicateChecker<1000> duplicate_checker_; + MessageIdDuplicateChecker<1000> updates_duplicate_checker_; + MessageIdDuplicateChecker<100> updates_duplicate_rechecker_; + + void update_salt(double now); +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/AuthKey.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/AuthKey.h new file mode 100644 index 0000000000..291833cf41 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/AuthKey.h @@ -0,0 +1,134 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/common.h" +#include "td/utils/port/Clocks.h" +#include "td/utils/Time.h" + +namespace td { +namespace mtproto { + +class AuthKey { + public: + AuthKey() = default; + AuthKey(uint64 auth_key_id, string &&auth_key) : auth_key_id_(auth_key_id), auth_key_(auth_key) { + } + void break_key() { + auth_key_id_++; + auth_key_[0]++; + } + + bool empty() const { + return auth_key_.empty(); + } + const string &key() const { + return auth_key_; + } + uint64 id() const { + return auth_key_id_; + } + bool auth_flag() const { + return auth_flag_; + } + void set_auth_flag(bool new_auth_flag) { + auth_flag_ = new_auth_flag; + } + + bool need_header() const { + return have_header_ || Time::now() < header_expires_at_; + } + void remove_header() { + if (auth_flag_ && have_header_) { + have_header_ = false; + header_expires_at_ = Time::now() + 3; + } + } + void restore_header() { + have_header_ = true; + } + + double expires_at() const { + return expires_at_; + } + double created_at() const { + return created_at_; + } + + void set_expires_at(double expires_at) { + expires_at_ = expires_at; + } + void set_created_at(double created_at) { + created_at_ = created_at; + } + void clear() { + auth_key_.clear(); + } + + static constexpr int32 AUTH_FLAG = 1; + static constexpr int32 HAS_CREATED_AT = 4; + static constexpr int32 HAS_EXPIRES_AT = 8; + + template + void store(StorerT &storer) const { + storer.store_binary(auth_key_id_); + bool has_created_at = created_at_ != 0; + bool has_expires_at = expires_at_ != 0; + int32 flags = 0; + if (auth_flag_) { + flags |= AUTH_FLAG; + } + if (has_created_at) { + flags |= HAS_CREATED_AT; + } + if (has_expires_at) { + flags |= HAS_EXPIRES_AT; + } + storer.store_binary(flags); + storer.store_string(auth_key_); + if (has_created_at) { + storer.store_binary(created_at_); + } + if (has_expires_at) { + double time_left = max(expires_at_ - Time::now(), 0.0); + storer.store_binary(time_left); + storer.store_binary(Clocks::system()); + } + } + + template + void parse(ParserT &parser) { + auth_key_id_ = parser.fetch_long(); + auto flags = parser.fetch_int(); + auth_flag_ = (flags & AUTH_FLAG) != 0; + auth_key_ = parser.template fetch_string(); + if ((flags & HAS_CREATED_AT) != 0) { + created_at_ = parser.fetch_double(); + } + if ((flags & HAS_EXPIRES_AT) != 0) { + double time_left = parser.fetch_double(); + double old_server_time = parser.fetch_double(); + double passed_server_time = max(Clocks::system() - old_server_time, 0.0); + time_left = max(time_left - passed_server_time, 0.0); + expires_at_ = Time::now() + time_left; + } + // just in case + have_header_ = true; + } + + private: + uint64 auth_key_id_{0}; + string auth_key_; + bool auth_flag_{false}; + bool have_header_{true}; + double header_expires_at_{0}; + double expires_at_{0}; + double created_at_{0}; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/ConnectionManager.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/ConnectionManager.h new file mode 100644 index 0000000000..0958711123 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/ConnectionManager.h @@ -0,0 +1,70 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/actor/actor.h" + +#include "td/utils/common.h" + +namespace td { +namespace mtproto { + +class ConnectionManager : public Actor { + public: + class ConnectionToken { + public: + ConnectionToken() = default; + explicit ConnectionToken(ActorShared connection_manager) + : connection_manager_(std::move(connection_manager)) { + } + ConnectionToken(const ConnectionToken &) = delete; + ConnectionToken &operator=(const ConnectionToken &) = delete; + ConnectionToken(ConnectionToken &&) = default; + ConnectionToken &operator=(ConnectionToken &&other) noexcept { + reset(); + connection_manager_ = std::move(other.connection_manager_); + return *this; + } + ~ConnectionToken() { + reset(); + } + + void reset() { + if (!connection_manager_.empty()) { + send_closure(connection_manager_, &ConnectionManager::dec_connect); + connection_manager_.reset(); + } + } + + bool empty() const { + return connection_manager_.empty(); + } + + private: + ActorShared connection_manager_; + }; + + static ConnectionToken connection(ActorId connection_manager) { + return connection_impl(connection_manager, 1); + } + static ConnectionToken connection_proxy(ActorId connection_manager) { + return connection_impl(connection_manager, 2); + } + + protected: + uint32 connect_cnt_ = 0; + uint32 connect_proxy_cnt_ = 0; + + private: + void inc_connect(); + void dec_connect(); + + static ConnectionToken connection_impl(ActorId connection_manager, int mode); +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/CryptoStorer.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/CryptoStorer.h new file mode 100644 index 0000000000..b094dccd14 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/CryptoStorer.h @@ -0,0 +1,371 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/AuthData.h" +#include "td/mtproto/MessageId.h" +#include "td/mtproto/MtprotoQuery.h" +#include "td/mtproto/PacketStorer.h" +#include "td/mtproto/utils.h" + +#include "td/mtproto/mtproto_api.h" + +#include "td/utils/common.h" +#include "td/utils/misc.h" +#include "td/utils/Slice.h" +#include "td/utils/Span.h" +#include "td/utils/StorerBase.h" +#include "td/utils/Time.h" + +namespace td { +namespace mtproto_api { +class msg_container { + public: + static const int32 ID = 0x73f1f8dc; +}; +} // namespace mtproto_api + +namespace mtproto { + +template +class ObjectImpl { + public: + ObjectImpl(bool not_empty, Object &&object, AuthData *auth_data) + : not_empty_(not_empty), object_(std::move(object)), object_storer_(object_) { + if (empty()) { + return; + } + message_id_ = auth_data->next_message_id(Time::now_cached()); + seq_no_ = auth_data->next_seq_no(false); + } + template + void do_store(StorerT &storer) const { + if (empty()) { + return; + } + storer.store_binary(message_id_); + storer.store_binary(seq_no_); + storer.store_binary(static_cast(object_storer_.size())); + storer.store_storer(object_storer_); + } + bool not_empty() const { + return not_empty_; + } + bool empty() const { + return !not_empty_; + } + MessageId get_message_id() const { + return message_id_; + } + + private: + bool not_empty_; + Object object_; + ObjectStorer object_storer_; + MessageId message_id_; + int32 seq_no_; +}; + +using AckImpl = ObjectImpl>; +using PingImpl = ObjectImpl>; +using HttpWaitImpl = ObjectImpl>; +using GetFutureSaltsImpl = ObjectImpl>; +using ResendImpl = ObjectImpl>; +using CancelImpl = ObjectImpl>; +using GetInfoImpl = ObjectImpl>; +using DestroyAuthKeyImpl = ObjectImpl>; + +class CancelVectorImpl { + public: + CancelVectorImpl(bool not_empty, const vector &to_cancel, AuthData *auth_data) { + storers_.reserve(to_cancel.size()); + for (auto &request_id : to_cancel) { + storers_.emplace_back(true, mtproto_api::rpc_drop_answer(request_id), auth_data); + } + } + + template + void do_store(StorerT &storer) const { + for (auto &s : storers_) { + storer.store_storer(s); + } + } + bool not_empty() const { + return !storers_.empty(); + } + MessageId get_message_id() const { + CHECK(storers_.size() == 1); + return storers_[0].get_message_id(); + } + + private: + vector> storers_; +}; + +class InvokeAfter { + public: + explicit InvokeAfter(Span message_ids) : message_ids_(message_ids) { + } + template + void store(StorerT &storer) const { + if (message_ids_.empty()) { + return; + } + if (message_ids_.size() == 1) { + storer.store_int(static_cast(0xcb9f372d)); + storer.store_binary(message_ids_[0].get()); + return; + } + // invokeAfterMsgs#3dc4b4f0 {X:Type} msg_ids:Vector query:!X = X; + storer.store_int(static_cast(0x3dc4b4f0)); + storer.store_int(static_cast(0x1cb5c415)); + storer.store_int(narrow_cast(message_ids_.size())); + for (auto message_id : message_ids_) { + storer.store_binary(message_id.get()); + } + } + + private: + Span message_ids_; +}; + +class QueryImpl { + public: + QueryImpl(const MtprotoQuery &query, Slice header) : query_(query), header_(header) { + } + + template + void do_store(StorerT &storer) const { + storer.store_binary(query_.message_id); + storer.store_binary(query_.seq_no); + + InvokeAfter invoke_after(query_.invoke_after_message_ids); + auto invoke_after_storer = create_default_storer(invoke_after); + + Slice data = query_.packet.as_slice(); + mtproto_api::gzip_packed packed(data); + auto plain_storer = create_storer(data); + auto gzip_storer = TLObjectStorer(packed); + const Storer &data_storer = + query_.gzip_flag ? static_cast(gzip_storer) : static_cast(plain_storer); + auto header_storer = create_storer(header_); + auto suff_storer = create_storer(invoke_after_storer, data_storer); + auto all_storer = create_storer(header_storer, suff_storer); + + storer.store_binary(static_cast(all_storer.size())); + storer.store_storer(all_storer); + } + + private: + const MtprotoQuery &query_; + Slice header_; +}; + +class QueryVectorImpl { + public: + QueryVectorImpl(const vector &to_send, Slice header) : to_send_(to_send), header_(header) { + } + + template + void do_store(StorerT &storer) const { + if (to_send_.empty()) { + return; + } + for (auto &query : to_send_) { + storer.store_storer(PacketStorer(query, header_)); + } + } + + private: + const vector &to_send_; + Slice header_; +}; + +class ContainerImpl { + public: + ContainerImpl(int32 cnt, Storer &storer) : cnt_(cnt), storer_(storer) { + } + + template + void do_store(StorerT &storer) const { + storer.store_binary(mtproto_api::msg_container::ID); + storer.store_binary(cnt_); + storer.store_storer(storer_); + } + + private: + int32 cnt_; + Storer &storer_; +}; + +class CryptoImpl { + public: + CryptoImpl(const vector &to_send, Slice header, vector &&to_ack, int64 ping_id, int ping_timeout, + int max_delay, int max_after, int max_wait, int future_salt_n, vector get_info, + vector resend, const vector &cancel, bool destroy_key, AuthData *auth_data, + MessageId *container_message_id, MessageId *get_info_message_id, MessageId *resend_message_id, + MessageId *ping_message_id, MessageId *parent_message_id) + : query_storer_(to_send, header) + , ack_empty_(to_ack.empty()) + , ack_storer_(!ack_empty_, mtproto_api::msgs_ack(std::move(to_ack)), auth_data) + , http_wait_storer_(max_delay >= 0, mtproto_api::http_wait(max_delay, max_after, max_wait), auth_data) + , get_future_salts_storer_(future_salt_n > 0, mtproto_api::get_future_salts(future_salt_n), auth_data) + , get_info_not_empty_(!get_info.empty()) + , get_info_storer_(get_info_not_empty_, mtproto_api::msgs_state_req(std::move(get_info)), auth_data) + , resend_not_empty_(!resend.empty()) + , resend_storer_(resend_not_empty_, mtproto_api::msg_resend_req(std::move(resend)), auth_data) + , cancel_not_empty_(!cancel.empty()) + , cancel_cnt_(static_cast(cancel.size())) + , cancel_storer_(cancel_not_empty_, cancel, auth_data) + , destroy_key_storer_(destroy_key, mtproto_api::destroy_auth_key(), auth_data) + , ping_storer_(ping_id != 0, mtproto_api::ping_delay_disconnect(ping_id, ping_timeout), auth_data) + , tmp_storer_(query_storer_, ack_storer_) + , tmp2_storer_(tmp_storer_, http_wait_storer_) + , tmp3_storer_(tmp2_storer_, get_future_salts_storer_) + , tmp4_storer_(tmp3_storer_, get_info_storer_) + , tmp5_storer_(tmp4_storer_, resend_storer_) + , tmp6_storer_(tmp5_storer_, cancel_storer_) + , tmp7_storer_(tmp6_storer_, destroy_key_storer_) + , concat_storer_(tmp7_storer_, ping_storer_) + , cnt_(static_cast(to_send.size()) + ack_storer_.not_empty() + ping_storer_.not_empty() + + http_wait_storer_.not_empty() + get_future_salts_storer_.not_empty() + get_info_storer_.not_empty() + + resend_storer_.not_empty() + cancel_cnt_ + destroy_key_storer_.not_empty()) + , container_storer_(cnt_, concat_storer_) { + CHECK(cnt_ != 0); + if (get_info_storer_.not_empty() && get_info_message_id) { + *get_info_message_id = get_info_storer_.get_message_id(); + } + if (resend_storer_.not_empty() && resend_message_id) { + *resend_message_id = resend_storer_.get_message_id(); + } + if (ping_storer_.not_empty() && ping_message_id) { + *ping_message_id = ping_storer_.get_message_id(); + } + + if (cnt_ > 1 || + (!to_send.empty() && !auth_data->is_valid_outbound_msg_id(to_send[0].message_id, Time::now_cached()))) { + type_ = Mixed; + message_id_ = auth_data->next_message_id(Time::now_cached()); + seq_no_ = auth_data->next_seq_no(false); + + *container_message_id = message_id_; + *parent_message_id = message_id_; + } else if (!to_send.empty()) { + CHECK(to_send.size() == 1u); + type_ = OnlyQuery; + *parent_message_id = to_send[0].message_id; + } else if (ack_storer_.not_empty()) { + type_ = OnlyAck; + *parent_message_id = ack_storer_.get_message_id(); + } else if (ping_storer_.not_empty()) { + type_ = OnlyPing; + *parent_message_id = ping_storer_.get_message_id(); + } else if (http_wait_storer_.not_empty()) { + type_ = OnlyHttpWait; + *parent_message_id = http_wait_storer_.get_message_id(); + } else if (get_future_salts_storer_.not_empty()) { + type_ = OnlyGetFutureSalts; + *parent_message_id = get_future_salts_storer_.get_message_id(); + } else if (get_info_storer_.not_empty()) { + type_ = OnlyGetInfo; + *parent_message_id = get_info_storer_.get_message_id(); + } else if (resend_storer_.not_empty()) { + type_ = OnlyResend; + *parent_message_id = resend_storer_.get_message_id(); + } else if (cancel_storer_.not_empty()) { + type_ = OnlyCancel; + *parent_message_id = cancel_storer_.get_message_id(); + } else if (destroy_key_storer_.not_empty()) { + type_ = OnlyDestroyKey; + *parent_message_id = destroy_key_storer_.get_message_id(); + } else { + UNREACHABLE(); + } + } + + template + void do_store(StorerT &storer) const { + switch (type_) { + case OnlyAck: + return storer.store_storer(ack_storer_); + + case OnlyQuery: + return storer.store_storer(query_storer_); + + case OnlyPing: + return storer.store_storer(ping_storer_); + + case OnlyHttpWait: + return storer.store_storer(http_wait_storer_); + + case OnlyGetFutureSalts: + return storer.store_storer(get_future_salts_storer_); + + case OnlyResend: + return storer.store_storer(resend_storer_); + + case OnlyCancel: + return storer.store_storer(cancel_storer_); + + case OnlyGetInfo: + return storer.store_storer(get_info_storer_); + + case OnlyDestroyKey: + return storer.store_storer(destroy_key_storer_); + + default: + storer.store_binary(message_id_); + storer.store_binary(seq_no_); + storer.store_binary(static_cast(container_storer_.size())); + storer.store_storer(container_storer_); + } + } + + private: + PacketStorer query_storer_; + bool ack_empty_; + PacketStorer ack_storer_; + PacketStorer http_wait_storer_; + PacketStorer get_future_salts_storer_; + bool get_info_not_empty_; + PacketStorer get_info_storer_; + bool resend_not_empty_; + PacketStorer resend_storer_; + bool cancel_not_empty_; + int32 cancel_cnt_; + PacketStorer cancel_storer_; + PacketStorer destroy_key_storer_; + PacketStorer ping_storer_; + ConcatStorer tmp_storer_; + ConcatStorer tmp2_storer_; + ConcatStorer tmp3_storer_; + ConcatStorer tmp4_storer_; + ConcatStorer tmp5_storer_; + ConcatStorer tmp6_storer_; + ConcatStorer tmp7_storer_; + ConcatStorer concat_storer_; + int32 cnt_; + PacketStorer container_storer_; + enum Type { + OnlyQuery, + OnlyAck, + OnlyPing, + OnlyHttpWait, + OnlyGetFutureSalts, + OnlyResend, + OnlyCancel, + OnlyGetInfo, + OnlyDestroyKey, + Mixed + }; + Type type_; + MessageId message_id_; + int32 seq_no_; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/DhCallback.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/DhCallback.h new file mode 100644 index 0000000000..6ed0dfb119 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/DhCallback.h @@ -0,0 +1,29 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/Slice.h" + +namespace td { +namespace mtproto { + +class DhCallback { + public: + DhCallback() = default; + DhCallback(const DhCallback &) = delete; + DhCallback &operator=(const DhCallback &) = delete; + DhCallback(DhCallback &&) = delete; + DhCallback &operator=(DhCallback &&) = delete; + virtual ~DhCallback() = default; + + virtual int is_good_prime(Slice prime_str) const = 0; + virtual void add_good_prime(Slice prime_str) const = 0; + virtual void add_bad_prime(Slice prime_str) const = 0; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/DhHandshake.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/DhHandshake.h new file mode 100644 index 0000000000..02ab86cb81 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/DhHandshake.h @@ -0,0 +1,124 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/BigNum.h" +#include "td/utils/common.h" +#include "td/utils/Slice.h" +#include "td/utils/Status.h" + +#include + +namespace td { +namespace mtproto { + +class DhCallback; + +class DhHandshake { + public: + void set_config(int32 g_int, Slice prime_str); + + static Status check_config(int32 g_int, Slice prime_str, DhCallback *callback); + + bool has_config() const { + return has_config_; + } + void set_g_a_hash(Slice g_a_hash); + void set_g_a(Slice g_a_str); + bool has_g_a() const { + return has_g_a_; + } + string get_g_a() const; + string get_g_b() const; + string get_g_b_hash() const; + Status run_checks(bool skip_config_check, DhCallback *callback) TD_WARN_UNUSED_RESULT; + + BigNum get_g() const; + BigNum get_p() const; + BigNum get_b() const; + BigNum get_g_ab(); + + std::pair gen_key(); + + static int64 calc_key_id(Slice auth_key); + + enum Flags { HasConfig = 1, HasGA = 2 }; + + template + void store(StorerT &storer) const { + auto flags = 0; + if (has_config_) { + flags |= HasConfig; + } + if (has_g_a_) { + flags |= HasGA; + } + storer.store_int(flags); + + if (has_config_) { + // prime_, prime_str_, b_, g_, g_int_, g_b_ + storer.store_string(prime_str_); + storer.store_string(b_.to_binary()); + storer.store_int(g_int_); + storer.store_string(g_b_.to_binary()); + } + if (has_g_a_) { + storer.store_string(g_a_.to_binary()); + } + } + template + void parse(ParserT &parser) { + auto flags = parser.fetch_int(); + if (flags & HasConfig) { + has_config_ = true; + } + if (flags & HasGA) { + has_g_a_ = true; + } + if (has_config_) { + // prime_, prime_str_, b_, g_, g_int_, g_b_ + prime_str_ = parser.template fetch_string(); + prime_ = BigNum::from_binary(prime_str_); + + b_ = BigNum::from_binary(parser.template fetch_string()); + + g_int_ = parser.fetch_int(); + g_.set_value(g_int_); + + g_b_ = BigNum::from_binary(parser.template fetch_string()); + } + if (has_g_a_) { + g_a_ = BigNum::from_binary(parser.template fetch_string()); + } + } + + private: + static Status check_config(Slice prime_str, const BigNum &prime, int32 g_int, BigNumContext &ctx, + DhCallback *callback) TD_WARN_UNUSED_RESULT; + + static Status dh_check(const BigNum &prime, const BigNum &g_a, const BigNum &g_b) TD_WARN_UNUSED_RESULT; + + string prime_str_; + BigNum prime_; + BigNum g_; + int32 g_int_ = 0; + BigNum b_; + BigNum g_b_; + BigNum g_a_; + + string g_a_hash_; + bool has_g_a_hash_{false}; + bool ok_g_a_hash_{false}; + + bool has_config_ = false; + bool has_g_a_ = false; + + BigNumContext ctx_; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Handshake.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Handshake.h new file mode 100644 index 0000000000..1b9795433f --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Handshake.h @@ -0,0 +1,109 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/AuthKey.h" +#include "td/mtproto/RSA.h" + +#include "td/utils/common.h" +#include "td/utils/Slice.h" +#include "td/utils/Status.h" +#include "td/utils/StorerBase.h" +#include "td/utils/StringBuilder.h" +#include "td/utils/UInt.h" + +namespace td { +namespace mtproto { + +class DhCallback; + +class AuthKeyHandshakeContext { + public: + virtual ~AuthKeyHandshakeContext() = default; + virtual DhCallback *get_dh_callback() = 0; + virtual PublicRsaKeyInterface *get_public_rsa_key_interface() = 0; +}; + +class AuthKeyHandshake { + public: + class Callback { + public: + Callback() = default; + Callback(const Callback &) = delete; + Callback &operator=(const Callback &) = delete; + virtual ~Callback() = default; + virtual void send_no_crypto(const Storer &storer) = 0; + }; + + AuthKeyHandshake(int32 dc_id, int32 expires_in); + + void set_timeout_in(double timeout_in); + + bool is_ready_for_finish() const; + + void on_finish(); + + void resume(Callback *connection); + + Status on_message(Slice message, Callback *connection, AuthKeyHandshakeContext *context) TD_WARN_UNUSED_RESULT; + + void clear(); + + const AuthKey &get_auth_key() const { + return auth_key_; + } + + AuthKey release_auth_key() { + return std::move(auth_key_); + } + + double get_server_time_diff() const { + return server_time_diff_; + } + + uint64 get_server_salt() const { + return server_salt_; + } + + private: + enum class State : int32 { Start, ResPQ, ServerDHParams, DHGenResponse, Finish }; + State state_ = State::Start; + enum class Mode : int32 { Main, Temp }; + Mode mode_ = Mode::Main; + int32 dc_id_ = 0; + int32 expires_in_ = 0; + double expires_at_ = 0; + + double start_time_ = 0; + double timeout_in_ = 0; + + AuthKey auth_key_; + double server_time_diff_ = 0; + uint64 server_salt_ = 0; + + UInt128 nonce_; + UInt128 server_nonce_; + UInt256 new_nonce_; + + string last_query_; + + template + static string store_object(const T &object); + + void send(Callback *connection, const Storer &storer); + static void do_send(Callback *connection, const Storer &storer); + + Status on_start(Callback *connection) TD_WARN_UNUSED_RESULT; + Status on_res_pq(Slice message, Callback *connection, PublicRsaKeyInterface *public_rsa_key) TD_WARN_UNUSED_RESULT; + Status on_server_dh_params(Slice message, Callback *connection, DhCallback *dh_callback) TD_WARN_UNUSED_RESULT; + Status on_dh_gen_response(Slice message, Callback *connection) TD_WARN_UNUSED_RESULT; + + friend StringBuilder &operator<<(StringBuilder &string_builder, const State &state); +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HandshakeActor.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HandshakeActor.h new file mode 100644 index 0000000000..c140e4ffe3 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HandshakeActor.h @@ -0,0 +1,56 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/Handshake.h" +#include "td/mtproto/HandshakeConnection.h" +#include "td/mtproto/RawConnection.h" + +#include "td/actor/actor.h" + +#include "td/utils/Promise.h" +#include "td/utils/Status.h" + +namespace td { +namespace mtproto { + +// Owns RawConnection. Generates new auth key. And returns it and RawConnection. Or error... +class HandshakeActor final : public Actor { + public: + HandshakeActor(unique_ptr handshake, unique_ptr raw_connection, + unique_ptr context, double timeout, + Promise> raw_connection_promise, + Promise> handshake_promise); + void close(); + + private: + unique_ptr handshake_; + unique_ptr connection_; + double timeout_; + + Promise> raw_connection_promise_; + Promise> handshake_promise_; + + void start_up() final; + + void tear_down() final; + + void hangup() final; + + void timeout_expired() final; + + void loop() final; + + void finish(Status status); + + void return_connection(Status status); + + void return_handshake(); +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HandshakeConnection.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HandshakeConnection.h new file mode 100644 index 0000000000..9d3cc3dba0 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HandshakeConnection.h @@ -0,0 +1,86 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/AuthKey.h" +#include "td/mtproto/Handshake.h" +#include "td/mtproto/MessageId.h" +#include "td/mtproto/NoCryptoStorer.h" +#include "td/mtproto/PacketInfo.h" +#include "td/mtproto/PacketStorer.h" +#include "td/mtproto/RawConnection.h" + +#include "td/utils/buffer.h" +#include "td/utils/common.h" +#include "td/utils/format.h" +#include "td/utils/logging.h" +#include "td/utils/port/detail/PollableFd.h" +#include "td/utils/Status.h" +#include "td/utils/StorerBase.h" + +namespace td { +namespace mtproto { + +class HandshakeConnection final + : private RawConnection::Callback + , private AuthKeyHandshake::Callback { + public: + HandshakeConnection(unique_ptr raw_connection, AuthKeyHandshake *handshake, + unique_ptr context) + : raw_connection_(std::move(raw_connection)), handshake_(handshake), context_(std::move(context)) { + handshake_->resume(this); + } + + PollableFdInfo &get_poll_info() { + return raw_connection_->get_poll_info(); + } + + unique_ptr move_as_raw_connection() { + return std::move(raw_connection_); + } + + void close() { + raw_connection_->close(); + } + + Status flush() { + auto status = raw_connection_->flush(AuthKey(), *this); + if (status.code() == -404) { + LOG(WARNING) << "Clear handshake " << tag("error", status); + handshake_->clear(); + } + return status; + } + + private: + unique_ptr raw_connection_; + AuthKeyHandshake *handshake_; + unique_ptr context_; + + void send_no_crypto(const Storer &storer) final { + raw_connection_->send_no_crypto(PacketStorer(MessageId(), storer)); + } + + Status on_raw_packet(const PacketInfo &packet_info, BufferSlice packet) final { + if (!packet_info.no_crypto_flag) { + return Status::Error("Expected not encrypted packet"); + } + + // skip header + if (packet.size() < 12) { + return Status::Error("Result is too small"); + } + packet.confirm_read(12); + + auto fixed_packet_size = packet.size() & ~3; // remove some padded data + TRY_STATUS(handshake_->on_message(packet.as_slice().truncate(fixed_packet_size), this, context_.get())); + return Status::OK(); + } +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HttpTransport.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HttpTransport.h new file mode 100644 index 0000000000..c153f43c03 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/HttpTransport.h @@ -0,0 +1,59 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/IStreamTransport.h" +#include "td/mtproto/ProxySecret.h" +#include "td/mtproto/TransportType.h" + +#include "td/net/HttpQuery.h" +#include "td/net/HttpReader.h" + +#include "td/utils/buffer.h" +#include "td/utils/common.h" +#include "td/utils/port/detail/PollableFd.h" +#include "td/utils/Status.h" + +namespace td { +namespace mtproto { +namespace http { + +class Transport final : public IStreamTransport { + public: + explicit Transport(string secret) : secret_(std::move(secret)) { + } + + Result read_next(BufferSlice *message, uint32 *quick_ack) final TD_WARN_UNUSED_RESULT; + bool support_quick_ack() const final { + return false; + } + void write(BufferWriter &&message, bool quick_ack) final; + bool can_read() const final; + bool can_write() const final; + void init(ChainBufferReader *input, ChainBufferWriter *output) final { + reader_.init(input); + output_ = output; + } + + size_t max_prepend_size() const final; + size_t max_append_size() const final; + TransportType get_type() const final { + return {TransportType::Http, 0, ProxySecret::from_raw(secret_)}; + } + bool use_random_padding() const final; + + private: + string secret_; + HttpReader reader_; + HttpQuery http_query_; + ChainBufferWriter *output_ = nullptr; + enum { Write, Read } turn_ = Write; +}; + +} // namespace http +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/IStreamTransport.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/IStreamTransport.h new file mode 100644 index 0000000000..06154f7d16 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/IStreamTransport.h @@ -0,0 +1,40 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/TransportType.h" + +#include "td/utils/buffer.h" +#include "td/utils/common.h" +#include "td/utils/port/detail/PollableFd.h" +#include "td/utils/Status.h" + +namespace td { +namespace mtproto { + +class IStreamTransport { + public: + IStreamTransport() = default; + IStreamTransport(const IStreamTransport &) = delete; + IStreamTransport &operator=(const IStreamTransport &) = delete; + virtual ~IStreamTransport() = default; + virtual Result read_next(BufferSlice *message, uint32 *quick_ack) = 0; + virtual bool support_quick_ack() const = 0; + virtual void write(BufferWriter &&message, bool quick_ack) = 0; + virtual bool can_read() const = 0; + virtual bool can_write() const = 0; + virtual void init(ChainBufferReader *input, ChainBufferWriter *output) = 0; + virtual size_t max_prepend_size() const = 0; + virtual size_t max_append_size() const = 0; + virtual TransportType get_type() const = 0; + virtual bool use_random_padding() const = 0; +}; + +unique_ptr create_transport(TransportType type); + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/KDF.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/KDF.h new file mode 100644 index 0000000000..44ee4b7121 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/KDF.h @@ -0,0 +1,22 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/Slice.h" +#include "td/utils/UInt.h" + +namespace td { +namespace mtproto { + +void KDF(Slice auth_key, const UInt128 &msg_key, int X, UInt256 *aes_key, UInt256 *aes_iv); + +void tmp_KDF(const UInt128 &server_nonce, const UInt256 &new_nonce, UInt256 *tmp_aes_key, UInt256 *tmp_aes_iv); + +void KDF2(Slice auth_key, const UInt128 &msg_key, int X, UInt256 *aes_key, UInt256 *aes_iv); + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/MessageId.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/MessageId.h new file mode 100644 index 0000000000..1f0cad0909 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/MessageId.h @@ -0,0 +1,70 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/common.h" +#include "td/utils/format.h" +#include "td/utils/HashTableUtils.h" +#include "td/utils/StringBuilder.h" + +#include + +namespace td { +namespace mtproto { + +class MessageId { + uint64 message_id_ = 0; + + public: + MessageId() = default; + + explicit constexpr MessageId(uint64 message_id) : message_id_(message_id) { + } + template ::value>> + MessageId(T message_id) = delete; + + uint64 get() const { + return message_id_; + } + + bool operator==(const MessageId &other) const { + return message_id_ == other.message_id_; + } + + bool operator!=(const MessageId &other) const { + return message_id_ != other.message_id_; + } + + friend bool operator<(const MessageId &lhs, const MessageId &rhs) { + return lhs.get() < rhs.get(); + } + + friend bool operator>(const MessageId &lhs, const MessageId &rhs) { + return lhs.get() > rhs.get(); + } + + friend bool operator<=(const MessageId &lhs, const MessageId &rhs) { + return lhs.get() <= rhs.get(); + } + + friend bool operator>=(const MessageId &lhs, const MessageId &rhs) { + return lhs.get() >= rhs.get(); + } +}; + +struct MessageIdHash { + uint32 operator()(MessageId message_id) const { + return Hash()(message_id.get()); + } +}; + +inline StringBuilder &operator<<(StringBuilder &string_builder, MessageId message_id) { + return string_builder << "message " << format::as_hex(message_id.get()); +} + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/MtprotoQuery.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/MtprotoQuery.h new file mode 100644 index 0000000000..229419a0fb --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/MtprotoQuery.h @@ -0,0 +1,27 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/MessageId.h" + +#include "td/utils/buffer.h" +#include "td/utils/common.h" + +namespace td { +namespace mtproto { + +struct MtprotoQuery { + MessageId message_id; + int32 seq_no; + BufferSlice packet; + bool gzip_flag; + vector invoke_after_message_ids; + bool use_quick_ack; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/NoCryptoStorer.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/NoCryptoStorer.h new file mode 100644 index 0000000000..c2d512932a --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/NoCryptoStorer.h @@ -0,0 +1,43 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/MessageId.h" + +#include "td/utils/Random.h" +#include "td/utils/StorerBase.h" + +namespace td { +namespace mtproto { + +class NoCryptoImpl { + public: + NoCryptoImpl(MessageId message_id, const Storer &data, bool need_pad = true) : message_id_(message_id), data_(data) { + if (need_pad) { + size_t pad_size = -static_cast(data_.size()) & 15; + pad_size += 16 * (static_cast(Random::secure_int32()) % 16); + pad_.resize(pad_size); + Random::secure_bytes(pad_); + } + } + + template + void do_store(StorerT &storer) const { + storer.store_binary(message_id_.get()); + storer.store_binary(static_cast(data_.size() + pad_.size())); + storer.store_storer(data_); + storer.store_slice(pad_); + } + + private: + MessageId message_id_; + const Storer &data_; + std::string pad_; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PacketInfo.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PacketInfo.h new file mode 100644 index 0000000000..787889191c --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PacketInfo.h @@ -0,0 +1,33 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/MessageId.h" + +#include "td/utils/common.h" + +namespace td { +namespace mtproto { + +struct PacketInfo { + enum { Common, EndToEnd } type = Common; + uint32 message_ack{0}; + + uint64 salt{0}; + uint64 session_id{0}; + + MessageId message_id; + int32 seq_no{0}; + int32 version{1}; + bool no_crypto_flag{false}; + bool is_creator{false}; + bool check_mod4{true}; + bool use_random_padding{false}; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PacketStorer.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PacketStorer.h new file mode 100644 index 0000000000..8e894add62 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PacketStorer.h @@ -0,0 +1,44 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/StorerBase.h" +#include "td/utils/tl_storers.h" + +#include + +namespace td { +namespace mtproto { + +template +class PacketStorer final + : public Storer + , public Impl { + public: + size_t size() const final { + if (size_ != std::numeric_limits::max()) { + return size_; + } + TlStorerCalcLength storer; + this->do_store(storer); + return size_ = storer.get_length(); + } + + size_t store(uint8 *ptr) const final { + TlStorerUnsafe storer(ptr); + this->do_store(storer); + return static_cast(storer.get_buf() - ptr); + } + + using Impl::Impl; + + private: + mutable size_t size_ = std::numeric_limits::max(); +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Ping.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Ping.h new file mode 100644 index 0000000000..b346907305 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Ping.h @@ -0,0 +1,25 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/AuthData.h" +#include "td/mtproto/RawConnection.h" + +#include "td/actor/actor.h" + +#include "td/utils/common.h" +#include "td/utils/Promise.h" +#include "td/utils/Slice.h" + +namespace td { +namespace mtproto { + +ActorOwn<> create_ping_actor(Slice actor_name, unique_ptr raw_connection, unique_ptr auth_data, + Promise> promise, ActorShared<> parent); + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PingConnection.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PingConnection.h new file mode 100644 index 0000000000..9520aaafac --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/PingConnection.h @@ -0,0 +1,34 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/AuthData.h" +#include "td/mtproto/RawConnection.h" + +#include "td/utils/common.h" +#include "td/utils/port/detail/PollableFd.h" +#include "td/utils/Status.h" + +namespace td { +namespace mtproto { + +class PingConnection { + public: + virtual ~PingConnection() = default; + virtual PollableFdInfo &get_poll_info() = 0; + virtual unique_ptr move_as_raw_connection() = 0; + virtual Status flush() = 0; + virtual bool was_pong() const = 0; + virtual double rtt() const = 0; + + static unique_ptr create_req_pq(unique_ptr raw_connection, size_t ping_count); + static unique_ptr create_ping_pong(unique_ptr raw_connection, + unique_ptr auth_data); +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/ProxySecret.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/ProxySecret.h new file mode 100644 index 0000000000..cce108bc71 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/ProxySecret.h @@ -0,0 +1,69 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/common.h" +#include "td/utils/Slice.h" +#include "td/utils/Status.h" + +namespace td { +namespace mtproto { + +class ProxySecret { + public: + static constexpr size_t MAX_DOMAIN_LENGTH = 182; // must be small enough to not overflow TLS-hello length + + static Result from_link(Slice encoded_secret, bool truncate_if_needed = false); + + static Result from_binary(Slice raw_unchecked_secret, bool truncate_if_needed = false); + + static ProxySecret from_raw(Slice raw_secret) { + ProxySecret result; + result.secret_ = raw_secret.str(); + return result; + } + + Slice get_raw_secret() const { + return secret_; + } + + Slice get_proxy_secret() const { + Slice proxy_secret(secret_); + if (proxy_secret.size() >= 17) { + return proxy_secret.substr(1, 16); + } + return proxy_secret; + } + + string get_encoded_secret() const; + + bool use_random_padding() const { + return secret_.size() >= 17; + } + + bool emulate_tls() const { + return secret_.size() >= 17 && static_cast(secret_[0]) == 0xee; + } + + string get_domain() const { + CHECK(emulate_tls()); + return secret_.substr(17); + } + + private: + friend bool operator==(const ProxySecret &lhs, const ProxySecret &rhs) { + return lhs.secret_ == rhs.secret_; + } + string secret_; +}; + +inline bool operator!=(const ProxySecret &lhs, const ProxySecret &rhs) { + return !(lhs == rhs); +} + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/RSA.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/RSA.h new file mode 100644 index 0000000000..6d08cf7a8f --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/RSA.h @@ -0,0 +1,49 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/BigNum.h" +#include "td/utils/common.h" +#include "td/utils/Slice.h" +#include "td/utils/Status.h" + +namespace td { +namespace mtproto { + +class RSA { + public: + RSA clone() const; + int64 get_fingerprint() const; + size_t size() const; + + bool encrypt(Slice from, MutableSlice to) const; + + void decrypt_signature(Slice from, MutableSlice to) const; + + static Result from_pem_public_key(Slice pem); + + private: + RSA(BigNum n, BigNum e); + BigNum n_; + BigNum e_; +}; + +class PublicRsaKeyInterface { + public: + virtual ~PublicRsaKeyInterface() = default; + + struct RsaKey { + RSA rsa; + int64 fingerprint; + }; + virtual Result get_rsa_key(const vector &fingerprints) = 0; + + virtual void drop_keys() = 0; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/RawConnection.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/RawConnection.h new file mode 100644 index 0000000000..250f52d16c --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/RawConnection.h @@ -0,0 +1,92 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/ConnectionManager.h" +#include "td/mtproto/PacketInfo.h" +#include "td/mtproto/TransportType.h" + +#include "td/utils/buffer.h" +#include "td/utils/BufferedFd.h" +#include "td/utils/common.h" +#include "td/utils/port/detail/PollableFd.h" +#include "td/utils/port/IPAddress.h" +#include "td/utils/port/SocketFd.h" +#include "td/utils/Status.h" +#include "td/utils/StorerBase.h" + +namespace td { +namespace mtproto { + +class AuthKey; + +class RawConnection { + public: + class StatsCallback { + public: + virtual ~StatsCallback() = default; + virtual void on_read(uint64 bytes) = 0; + virtual void on_write(uint64 bytes) = 0; + + virtual void on_pong() = 0; // called when we know that connection is alive + virtual void on_error() = 0; // called on RawConnection error. Such error should be very rare on good connections. + virtual void on_mtproto_error() = 0; + }; + RawConnection() = default; + RawConnection(const RawConnection &) = delete; + RawConnection &operator=(const RawConnection &) = delete; + virtual ~RawConnection(); + + static unique_ptr create(IPAddress ip_address, BufferedFd buffered_socket_fd, + TransportType transport_type, unique_ptr stats_callback); + + virtual void set_connection_token(ConnectionManager::ConnectionToken connection_token) = 0; + + virtual bool can_send() const = 0; + virtual TransportType get_transport_type() const = 0; + virtual size_t send_crypto(const Storer &storer, uint64 session_id, int64 salt, const AuthKey &auth_key, + uint64 quick_ack_token) = 0; + virtual void send_no_crypto(const Storer &storer) = 0; + + virtual PollableFdInfo &get_poll_info() = 0; + virtual StatsCallback *stats_callback() = 0; + + class Callback { + public: + Callback() = default; + Callback(const Callback &) = delete; + Callback &operator=(const Callback &) = delete; + virtual ~Callback() = default; + virtual Status on_raw_packet(const PacketInfo &packet_info, BufferSlice packet) = 0; + virtual Status on_quick_ack(uint64 quick_ack_token) { + return Status::Error("Quick acknowledgements aren't supported by the callback"); + } + virtual Status before_write() { + return Status::OK(); + } + virtual void on_read(size_t size) { + } + }; + + // NB: After first returned error, all subsequent calls will return error too. + virtual Status flush(const AuthKey &auth_key, Callback &callback) TD_WARN_UNUSED_RESULT = 0; + virtual bool has_error() const = 0; + + virtual void close() = 0; + + struct PublicFields { + uint32 extra{0}; + string debug_str; + double rtt{0}; + }; + + virtual PublicFields &extra() = 0; + virtual const PublicFields &extra() const = 0; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/SessionConnection.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/SessionConnection.h new file mode 100644 index 0000000000..41240235db --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/SessionConnection.h @@ -0,0 +1,288 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/MessageId.h" +#include "td/mtproto/MtprotoQuery.h" +#include "td/mtproto/PacketInfo.h" +#include "td/mtproto/RawConnection.h" + +#include "td/utils/buffer.h" +#include "td/utils/common.h" +#include "td/utils/FlatHashMap.h" +#include "td/utils/logging.h" +#include "td/utils/Named.h" +#include "td/utils/port/detail/PollableFd.h" +#include "td/utils/ScopeGuard.h" +#include "td/utils/Slice.h" +#include "td/utils/Status.h" +#include "td/utils/StorerBase.h" +#include "td/utils/StringBuilder.h" +#include "td/utils/tl_parsers.h" + +#include + +namespace td { + +extern int VERBOSITY_NAME(mtproto); + +namespace mtproto_api { +class new_session_created; +class bad_msg_notification; +class bad_server_salt; +class msgs_ack; +class gzip_packed; +class pong; +class future_salts; +class msgs_state_info; +class msgs_all_info; +class msg_detailed_info; +class msg_new_detailed_info; +class DestroyAuthKeyRes; +class destroy_auth_key_ok; +class destroy_auth_key_fail; +class destroy_auth_key_none; +} // namespace mtproto_api + +namespace mtproto { + +class AuthData; + +class SessionConnection final + : public Named + , private RawConnection::Callback { + public: + enum class Mode : int32 { Tcp, Http, HttpLongPoll }; + SessionConnection(Mode mode, unique_ptr raw_connection, AuthData *auth_data); + SessionConnection(const SessionConnection &) = delete; + SessionConnection &operator=(const SessionConnection &) = delete; + SessionConnection(SessionConnection &&) = delete; + SessionConnection &operator=(SessionConnection &&) = delete; + ~SessionConnection() = default; + + PollableFdInfo &get_poll_info(); + unique_ptr move_as_raw_connection(); + + // Interface + MessageId send_query(BufferSlice buffer, bool gzip_flag, MessageId message_id, + vector invoke_after_message_ids, bool use_quick_ack); + + std::pair encrypted_bind(int64 perm_key, int64 nonce, int32 expires_at); + + void get_state_info(MessageId message_id); + + void resend_answer(MessageId message_id); + + void cancel_answer(MessageId message_id); + + void destroy_key(); + + void set_online(bool online_flag, bool is_main); + + void force_ack(); + + Slice get_debug_str() const { + return raw_connection_ == nullptr ? Slice() : raw_connection_->extra().debug_str; + } + + class Callback { + public: + Callback() = default; + Callback(const Callback &) = delete; + Callback &operator=(const Callback &) = delete; + virtual ~Callback() = default; + + virtual void on_connected() = 0; + virtual void on_closed(Status status) = 0; + + virtual void on_server_salt_updated() = 0; + virtual void on_server_time_difference_updated(bool force) = 0; + + virtual void on_new_session_created(uint64 unique_id, MessageId first_message_id) = 0; + virtual void on_session_failed(Status status) = 0; + + virtual void on_container_sent(MessageId container_message_id, vector message_ids) = 0; + virtual Status on_pong(double ping_time, double pong_time, double current_time) = 0; + + virtual Status on_update(BufferSlice packet) = 0; + + virtual void on_message_ack(MessageId message_id) = 0; + virtual Status on_message_result_ok(MessageId message_id, BufferSlice packet, size_t original_size) = 0; + virtual void on_message_result_error(MessageId message_id, int code, string message) = 0; + virtual void on_message_failed(MessageId message_id, Status status) = 0; + virtual void on_message_info(MessageId message_id, int32 state, MessageId answer_message_id, int32 answer_size, + int32 source) = 0; + + virtual Status on_destroy_auth_key() = 0; + }; + + double flush(SessionConnection::Callback *callback); + + // NB: Do not call force_close after on_closed callback + void force_close(SessionConnection::Callback *callback); + + private: + static constexpr int ACK_DELAY = 30; // 30s + static constexpr double QUERY_DELAY = 0.001; // 0.001s + static constexpr double RESEND_ANSWER_DELAY = 0.001; // 0.001s + + struct MsgInfo { + MessageId message_id; + int32 seq_no; + size_t size; + }; + + friend StringBuilder &operator<<(StringBuilder &string_builder, const MsgInfo &info); + + bool online_flag_ = false; + bool is_main_ = false; + bool was_moved_ = false; + + double rtt() const { + return max(2.0, raw_connection_->extra().rtt * 1.5 + 1); + } + + double read_disconnect_delay() const { + return online_flag_ ? rtt() * 3.5 : 135 + random_delay_; + } + + double ping_disconnect_delay() const { + return online_flag_ && is_main_ ? rtt() * 2.5 : 135 + random_delay_; + } + + double ping_may_delay() const { + return online_flag_ ? rtt() * 0.5 : 30 + random_delay_; + } + + double ping_must_delay() const { + return online_flag_ ? rtt() : 60 + random_delay_; + } + + double http_max_wait() const { + return 25.0; // 25s. Longer could be closed by proxy + } + static constexpr int HTTP_MAX_AFTER = 10; // 0.01s + static constexpr int HTTP_MAX_DELAY = 30; // 0.03s + + vector to_send_; + vector to_ack_message_ids_; + double force_send_at_ = 0; + + struct ServiceQuery { + enum Type { GetStateInfo, ResendAnswer } type_; + MessageId container_message_id_; + vector msg_ids_; + }; + vector to_resend_answer_message_ids_; + vector to_cancel_answer_message_ids_; + vector to_get_state_info_message_ids_; + FlatHashMap service_queries_; + + // nobody cleans up this map. But it should be really small. + FlatHashMap, MessageIdHash> container_to_service_message_id_; + + double random_delay_ = 0; + double last_read_at_ = 0; + double last_ping_at_ = 0; + double last_pong_at_ = 0; + double real_last_read_at_ = 0; + double real_last_pong_at_ = 0; + MessageId last_ping_message_id_; + MessageId last_ping_container_message_id_; + + uint64 last_read_size_ = 0; + uint64 last_write_size_ = 0; + + bool need_destroy_auth_key_ = false; + bool sent_destroy_auth_key_ = false; + double destroy_auth_key_send_time_ = 0.0; + + double flush_packet_at_ = 0; + + double last_get_future_salt_at_ = 0; + enum { Init, Run, Fail, Closed } state_; + Mode mode_; + bool connected_flag_ = false; + + MessageId container_message_id_; + MessageId main_message_id_; + double created_at_ = 0; + + unique_ptr raw_connection_; + AuthData *const auth_data_; + SessionConnection::Callback *callback_ = nullptr; + BufferSlice *current_buffer_slice_ = nullptr; + + BufferSlice as_buffer_slice(Slice packet); + auto set_buffer_slice(BufferSlice *buffer_slice) TD_WARN_UNUSED_RESULT { + auto old_buffer_slice = current_buffer_slice_; + current_buffer_slice_ = buffer_slice; + return ScopeExit() + [&to = current_buffer_slice_, from = old_buffer_slice] { + to = from; + }; + } + + void reset_server_time_difference(MessageId message_id); + + static Status parse_message(TlParser &parser, MsgInfo *info, Slice *packet, + bool crypto_flag = true) TD_WARN_UNUSED_RESULT; + Status parse_packet(TlParser &parser) TD_WARN_UNUSED_RESULT; + Status on_packet_container(const MsgInfo &info, Slice packet) TD_WARN_UNUSED_RESULT; + Status on_packet_rpc_result(const MsgInfo &info, Slice packet) TD_WARN_UNUSED_RESULT; + + template + Status on_packet(const MsgInfo &info, const T &packet) TD_WARN_UNUSED_RESULT; + + Status on_packet(const MsgInfo &info, + const mtproto_api::new_session_created &new_session_created) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, + const mtproto_api::bad_msg_notification &bad_msg_notification) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, const mtproto_api::bad_server_salt &bad_server_salt) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, const mtproto_api::msgs_ack &msgs_ack) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, const mtproto_api::gzip_packed &gzip_packed) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, const mtproto_api::pong &pong) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, const mtproto_api::future_salts &salts) TD_WARN_UNUSED_RESULT; + + Status on_msgs_state_info(const vector &msg_ids, Slice info) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, const mtproto_api::msgs_state_info &msgs_state_info) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, const mtproto_api::msgs_all_info &msgs_all_info) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, const mtproto_api::msg_detailed_info &msg_detailed_info) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, + const mtproto_api::msg_new_detailed_info &msg_new_detailed_info) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, const mtproto_api::destroy_auth_key_ok &destroy_auth_key) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, + const mtproto_api::destroy_auth_key_none &destroy_auth_key) TD_WARN_UNUSED_RESULT; + Status on_packet(const MsgInfo &info, + const mtproto_api::destroy_auth_key_fail &destroy_auth_key) TD_WARN_UNUSED_RESULT; + Status on_destroy_auth_key(const mtproto_api::DestroyAuthKeyRes &destroy_auth_key); + + Status on_slice_packet(const MsgInfo &info, Slice packet) TD_WARN_UNUSED_RESULT; + Status on_main_packet(const PacketInfo &packet_info, Slice packet) TD_WARN_UNUSED_RESULT; + void on_message_failed(MessageId message_id, Status status); + void on_message_failed_inner(MessageId message_id); + + void do_close(Status status); + + void send_ack(MessageId message_id); + void send_crypto(const Storer &storer, uint64 quick_ack_token); + void send_before(double tm); + bool may_ping() const; + bool must_ping() const; + bool must_flush_packet(); + void flush_packet(); + + Status init() TD_WARN_UNUSED_RESULT; + Status do_flush() TD_WARN_UNUSED_RESULT; + + Status before_write() final TD_WARN_UNUSED_RESULT; + Status on_raw_packet(const PacketInfo &packet_info, BufferSlice packet) final; + Status on_quick_ack(uint64 quick_ack_token) final; + void on_read(size_t size) final; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TcpTransport.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TcpTransport.h new file mode 100644 index 0000000000..00efd5cc1b --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TcpTransport.h @@ -0,0 +1,181 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/IStreamTransport.h" +#include "td/mtproto/ProxySecret.h" +#include "td/mtproto/TlsReaderByteFlow.h" +#include "td/mtproto/TransportType.h" + +#include "td/utils/AesCtrByteFlow.h" +#include "td/utils/buffer.h" +#include "td/utils/ByteFlow.h" +#include "td/utils/common.h" +#include "td/utils/crypto.h" +#include "td/utils/port/detail/PollableFd.h" +#include "td/utils/Status.h" +#include "td/utils/UInt.h" + +namespace td { +namespace mtproto { +namespace tcp { + +class IntermediateTransport { + public: + explicit IntermediateTransport(bool with_padding) : with_padding_(with_padding) { + } + + // Writes a packet into message. + // Returns 0 if everything is ok, and [expected_size] otherwise. + // There is no sense to call this function when [stream->size > expected_size] + // + // (TCP is a stream-oriented protocol, so the input message is a stream, not a slice) + size_t read_from_stream(ChainBufferReader *stream, BufferSlice *message, uint32 *quick_ack); + + // Writes header inplace. + void write_prepare_inplace(BufferWriter *message, bool quick_ack); + + // Writes first several bytes into output stream. + void init_output_stream(ChainBufferWriter *stream); + + bool with_padding() const { + return with_padding_; + } + + private: + bool with_padding_; +}; + +class OldTransport final : public IStreamTransport { + public: + OldTransport() = default; + Result read_next(BufferSlice *message, uint32 *quick_ack) final TD_WARN_UNUSED_RESULT { + return impl_.read_from_stream(input_, message, quick_ack); + } + bool support_quick_ack() const final { + return true; + } + void write(BufferWriter &&message, bool quick_ack) final { + impl_.write_prepare_inplace(&message, quick_ack); + output_->append(message.as_buffer_slice()); + } + void init(ChainBufferReader *input, ChainBufferWriter *output) final { + input_ = input; + output_ = output; + impl_.init_output_stream(output_); + } + bool can_read() const final { + return true; + } + bool can_write() const final { + return true; + } + + size_t max_prepend_size() const final { + return 4; + } + + size_t max_append_size() const final { + return 15; + } + + TransportType get_type() const final { + return TransportType{TransportType::Tcp, 0, ProxySecret()}; + } + + bool use_random_padding() const final { + return false; + } + + private: + IntermediateTransport impl_{false}; + ChainBufferReader *input_{nullptr}; + ChainBufferWriter *output_{nullptr}; +}; + +class ObfuscatedTransport final : public IStreamTransport { + public: + ObfuscatedTransport(int16 dc_id, ProxySecret secret) + : dc_id_(dc_id), secret_(std::move(secret)), impl_(secret_.use_random_padding()) { + } + + Result read_next(BufferSlice *message, uint32 *quick_ack) final TD_WARN_UNUSED_RESULT; + + bool support_quick_ack() const final { + return true; + } + + void write(BufferWriter &&message, bool quick_ack) final; + + void init(ChainBufferReader *input, ChainBufferWriter *output) final; + + bool can_read() const final { + return true; + } + + bool can_write() const final { + return true; + } + + size_t max_prepend_size() const final { + size_t res = 4; + if (secret_.emulate_tls()) { + res += 5; + if (is_first_tls_packet_) { + res += 6; + } + } + res += header_.size(); + if (res & 3) { + res += 4 - (res & 3); + } + return res; + } + + size_t max_append_size() const final { + return 15; + } + + TransportType get_type() const final { + return TransportType{TransportType::ObfuscatedTcp, dc_id_, secret_}; + } + + bool use_random_padding() const final { + return secret_.use_random_padding(); + } + + private: + int16 dc_id_; + bool is_first_tls_packet_{true}; + ProxySecret secret_; + std::string header_; + IntermediateTransport impl_; + TlsReaderByteFlow tls_reader_byte_flow_; + AesCtrByteFlow aes_ctr_byte_flow_; + ByteFlowSink byte_flow_sink_; + ChainBufferReader *input_ = nullptr; + + static constexpr int32 MAX_TLS_PACKET_LENGTH = 2878; + + // TODO: use ByteFlow? + // One problem is that BufferedFd owns output_buffer_ + // The other problem is that first 56 bytes must be sent unencrypted. + UInt256 output_key_; + AesCtrState output_state_; + ChainBufferWriter *output_ = nullptr; + + void do_write_tls(BufferWriter &&message); + void do_write_tls(BufferBuilder &&builder); + void do_write_main(BufferWriter &&message); + void do_write(BufferSlice &&message); +}; + +using Transport = ObfuscatedTransport; + +} // namespace tcp +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TlsInit.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TlsInit.h new file mode 100644 index 0000000000..519ee11acd --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TlsInit.h @@ -0,0 +1,51 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/net/TransparentProxy.h" + +#include "td/actor/actor.h" + +#include "td/utils/common.h" +#include "td/utils/port/IPAddress.h" +#include "td/utils/port/SocketFd.h" +#include "td/utils/Slice.h" +#include "td/utils/Status.h" + +namespace td { +namespace mtproto { + +class Grease { + public: + static void init(MutableSlice res); +}; + +class TlsInit final : public TransparentProxy { + public: + TlsInit(SocketFd socket_fd, string domain, string secret, unique_ptr callback, ActorShared<> parent, + double server_time_difference) + : TransparentProxy(std::move(socket_fd), IPAddress(), std::move(domain), std::move(secret), std::move(callback), + std::move(parent)) + , server_time_difference_(server_time_difference) { + } + + private: + double server_time_difference_{0}; + enum class State { + SendHello, + WaitHelloResponse, + } state_ = State::SendHello; + std::string hello_rand_; + + void send_hello(); + Status wait_hello_response(); + + Status loop_impl() final; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TlsReaderByteFlow.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TlsReaderByteFlow.h new file mode 100644 index 0000000000..ea6468d224 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TlsReaderByteFlow.h @@ -0,0 +1,20 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/ByteFlow.h" + +namespace td { +namespace mtproto { + +class TlsReaderByteFlow final : public ByteFlowBase { + public: + bool loop() final; +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Transport.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Transport.h new file mode 100644 index 0000000000..4cd04cf0e6 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/Transport.h @@ -0,0 +1,139 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/PacketInfo.h" + +#include "td/utils/buffer.h" +#include "td/utils/common.h" +#include "td/utils/logging.h" +#include "td/utils/Slice.h" +#include "td/utils/Status.h" +#include "td/utils/StorerBase.h" +#include "td/utils/UInt.h" + +#include + +namespace td { + +extern int VERBOSITY_NAME(raw_mtproto); + +namespace mtproto { + +class AuthKey; + +class Transport { + public: + class ReadResult { + public: + enum Type { Packet, Nop, Error, Quickack }; + + static ReadResult make_nop() { + return {}; + } + static ReadResult make_error(int32 error_code) { + ReadResult res; + res.type_ = Error; + res.error_code_ = error_code; + return res; + } + static ReadResult make_packet(MutableSlice packet) { + CHECK(!packet.empty()); + ReadResult res; + res.type_ = Packet; + res.packet_ = packet; + return res; + } + static ReadResult make_quick_ack(uint32 quick_ack) { + ReadResult res; + res.type_ = Quickack; + res.quick_ack_ = quick_ack; + return res; + } + + Type type() const { + return type_; + } + + MutableSlice packet() const { + CHECK(type_ == Packet); + return packet_; + } + uint32 quick_ack() const { + CHECK(type_ == Quickack); + return quick_ack_; + } + int32 error() const { + CHECK(type_ == Error); + return error_code_; + } + + private: + Type type_ = Nop; + MutableSlice packet_; + int32 error_code_ = 0; + uint32 quick_ack_ = 0; + }; + + static Result read_auth_key_id(Slice message); + + // Reads MTProto packet from [message] and saves it into [data]. + // If message is encrypted, [auth_key] is used. + // Decryption and unpacking is made inplace, so [data] will be subslice of [message]. + // Returns size of MTProto packet. + // If dest.size() >= size, the packet is also written into [dest]. + // If auth_key is nonempty, encryption will be used. + static Result read(MutableSlice message, const AuthKey &auth_key, + PacketInfo *packet_info) TD_WARN_UNUSED_RESULT; + + static BufferWriter write(const Storer &storer, const AuthKey &auth_key, PacketInfo *packet_info, + size_t prepend_size = 0, size_t append_size = 0); + + // public for testing purposes + static std::pair calc_message_key2(const AuthKey &auth_key, int X, Slice to_encrypt); + + private: + template + static std::pair calc_message_ack_and_key(const HeaderT &head, size_t data_size); + + template + static size_t calc_crypto_size(size_t data_size); + + template + static size_t calc_crypto_size2(size_t data_size, PacketInfo *packet_info); + + static size_t calc_no_crypto_size(size_t data_size); + + static Status read_no_crypto(MutableSlice message, PacketInfo *packet_info, MutableSlice *data) TD_WARN_UNUSED_RESULT; + + static Status read_crypto(MutableSlice message, const AuthKey &auth_key, PacketInfo *packet_info, + MutableSlice *data) TD_WARN_UNUSED_RESULT; + + static Status read_e2e_crypto(MutableSlice message, const AuthKey &auth_key, PacketInfo *packet_info, + MutableSlice *data) TD_WARN_UNUSED_RESULT; + + template + static Status read_crypto_impl(int X, MutableSlice message, const AuthKey &auth_key, HeaderT **header_ptr, + PrefixT **prefix_ptr, MutableSlice *data, + PacketInfo *packet_info) TD_WARN_UNUSED_RESULT; + + static BufferWriter write_no_crypto(const Storer &storer, PacketInfo *packet_info, size_t prepend_size, + size_t append_size); + + static BufferWriter write_crypto(const Storer &storer, const AuthKey &auth_key, PacketInfo *packet_info, + size_t prepend_size, size_t append_size); + + static BufferWriter write_e2e_crypto(const Storer &storer, const AuthKey &auth_key, PacketInfo *packet_info, + size_t prepend_size, size_t append_size); + + template + static void write_crypto_impl(int X, const Storer &storer, const AuthKey &auth_key, PacketInfo *packet_info, + HeaderT *header, size_t data_size, size_t padded_size); +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TransportType.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TransportType.h new file mode 100644 index 0000000000..51ede8e758 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/TransportType.h @@ -0,0 +1,27 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/mtproto/ProxySecret.h" + +#include "td/utils/common.h" + +namespace td { +namespace mtproto { + +struct TransportType { + enum Type { Tcp, ObfuscatedTcp, Http } type = Tcp; + int16 dc_id{0}; + ProxySecret secret; + + TransportType() = default; + TransportType(Type type, int16 dc_id, ProxySecret secret) : type(type), dc_id(dc_id), secret(std::move(secret)) { + } +}; + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/utils.h b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/utils.h new file mode 100644 index 0000000000..5519887b3f --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/mtproto/utils.h @@ -0,0 +1,55 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/Storer.h" +#include "td/utils/StorerBase.h" +#include "td/utils/tl_storers.h" + +#include + +namespace td { + +template +using TLStorer = DefaultStorer; + +template +class TLObjectStorer final : public Storer { + mutable size_t size_ = std::numeric_limits::max(); + const T &object_; + + public: + explicit TLObjectStorer(const T &object) : object_(object) { + } + + size_t size() const final { + if (size_ == std::numeric_limits::max()) { + TlStorerCalcLength storer; + storer.store_binary(T::ID); + object_.store(storer); + size_ = storer.get_length(); + } + return size_; + } + size_t store(uint8 *ptr) const final { + TlStorerUnsafe storer(ptr); + storer.store_binary(T::ID); + object_.store(storer); + return static_cast(storer.get_buf() - ptr); + } +}; + +namespace mtproto_api { +class Function; +} // namespace mtproto_api + +namespace mtproto { + +TLStorer create_function_storer(const mtproto_api::Function &function); + +} // namespace mtproto +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccentColorId.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccentColorId.h new file mode 100644 index 0000000000..deba6222bb --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccentColorId.h @@ -0,0 +1,82 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/telegram/ChannelId.h" +#include "td/telegram/ChatId.h" +#include "td/telegram/UserId.h" + +#include "td/utils/common.h" +#include "td/utils/HashTableUtils.h" +#include "td/utils/StringBuilder.h" + +#include + +namespace td { + +class AccentColorId { + int32 id = -1; + + public: + AccentColorId() = default; + + explicit constexpr AccentColorId(int32 accent_color_id) : id(accent_color_id) { + } + template ::value>> + AccentColorId(T accent_color_id) = delete; + + explicit AccentColorId(UserId user_id) : id(static_cast(user_id.get() % 7)) { + } + + explicit AccentColorId(ChatId chat_id) : id(static_cast(chat_id.get() % 7)) { + } + + explicit AccentColorId(ChannelId channel_id) : id(static_cast(channel_id.get() % 7)) { + } + + bool is_valid() const { + return id >= 0; + } + + bool is_built_in() const { + return 0 <= id && id < 7; + } + + int32 get() const { + return id; + } + + bool operator==(const AccentColorId &other) const { + return id == other.id; + } + + bool operator!=(const AccentColorId &other) const { + return id != other.id; + } + + template + void store(StorerT &storer) const { + storer.store_int(id); + } + + template + void parse(ParserT &parser) { + id = parser.fetch_int(); + } +}; + +struct AccentColorIdHash { + uint32 operator()(AccentColorId accent_color_id) const { + return Hash()(accent_color_id.get()); + } +}; + +inline StringBuilder &operator<<(StringBuilder &string_builder, AccentColorId accent_color_id) { + return string_builder << "accent color #" << accent_color_id.get(); +} + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccessRights.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccessRights.h new file mode 100644 index 0000000000..b02e4c6283 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccessRights.h @@ -0,0 +1,15 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/utils/common.h" + +namespace td { + +enum class AccessRights : int32 { Know, Read, Edit, Write }; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccountManager.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccountManager.h new file mode 100644 index 0000000000..7f8e25a4e7 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AccountManager.h @@ -0,0 +1,136 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/telegram/td_api.h" + +#include "td/actor/actor.h" + +#include "td/utils/common.h" +#include "td/utils/Promise.h" + +namespace td { + +struct BinlogEvent; + +class Td; + +class AccountManager final : public Actor { + public: + AccountManager(Td *td, ActorShared<> parent); + AccountManager(const AccountManager &) = delete; + AccountManager &operator=(const AccountManager &) = delete; + AccountManager(AccountManager &&) = delete; + AccountManager &operator=(AccountManager &&) = delete; + ~AccountManager() final; + + void set_default_message_ttl(int32 message_ttl, Promise &&promise); + + void get_default_message_ttl(Promise &&promise); + + void set_account_ttl(int32 account_ttl, Promise &&promise); + + void get_account_ttl(Promise &&promise); + + void confirm_qr_code_authentication(const string &link, Promise> &&promise); + + void get_active_sessions(Promise> &&promise); + + void terminate_session(int64 session_id, Promise &&promise); + + void terminate_all_other_sessions(Promise &&promise); + + void confirm_session(int64 session_id, Promise &&promise); + + void toggle_session_can_accept_calls(int64 session_id, bool can_accept_calls, Promise &&promise); + + void toggle_session_can_accept_secret_chats(int64 session_id, bool can_accept_secret_chats, Promise &&promise); + + void set_inactive_session_ttl_days(int32 authorization_ttl_days, Promise &&promise); + + void get_connected_websites(Promise> &&promise); + + void disconnect_website(int64 website_id, Promise &&promise); + + void disconnect_all_websites(Promise &&promise); + + void get_user_link(Promise> &&promise); + + void import_contact_token(const string &token, Promise> &&promise); + + void invalidate_authentication_codes(vector &&authentication_codes); + + void update_unconfirmed_authorization_timeout(bool is_external); + + void on_new_unconfirmed_authorization(int64 hash, int32 date, string &&device, string &&location); + + bool on_confirm_authorization(int64 hash); + + void on_binlog_events(vector &&events); + + void get_current_state(vector> &updates) const; + + private: + class UnconfirmedAuthorization; + class UnconfirmedAuthorizations; + + class ChangeAuthorizationSettingsOnServerLogEvent; + class InvalidateSignInCodesOnServerLogEvent; + class ResetAuthorizationOnServerLogEvent; + class ResetAuthorizationsOnServerLogEvent; + class ResetWebAuthorizationOnServerLogEvent; + class ResetWebAuthorizationsOnServerLogEvent; + class SetAccountTtlOnServerLogEvent; + class SetAuthorizationTtlOnServerLogEvent; + class SetDefaultHistoryTtlOnServerLogEvent; + + void start_up() final; + + void timeout_expired() final; + + void tear_down() final; + + void get_user_link_impl(Promise> &&promise); + + static string get_unconfirmed_authorizations_key(); + + void save_unconfirmed_authorizations() const; + + bool delete_expired_unconfirmed_authorizations(); + + td_api::object_ptr get_update_unconfirmed_session() const; + + void send_update_unconfirmed_session() const; + + void change_authorization_settings_on_server(int64 hash, bool set_encrypted_requests_disabled, + bool encrypted_requests_disabled, bool set_call_requests_disabled, + bool call_requests_disabled, bool confirm, uint64 log_event_id, + Promise &&promise); + + void invalidate_sign_in_codes_on_server(vector authentication_codes, uint64 log_event_id); + + void reset_authorization_on_server(int64 hash, uint64 log_event_id, Promise &&promise); + + void reset_authorizations_on_server(uint64 log_event_id, Promise &&promise); + + void reset_web_authorization_on_server(int64 hash, uint64 log_event_id, Promise &&promise); + + void reset_web_authorizations_on_server(uint64 log_event_id, Promise &&promise); + + void set_account_ttl_on_server(int32 account_ttl, uint64 log_event_id, Promise &&promise); + + void set_authorization_ttl_on_server(int32 authorization_ttl_days, uint64 log_event_id, Promise &&promise); + + void set_default_history_ttl_on_server(int32 message_ttl, uint64 log_event_id, Promise &&promise); + + Td *td_; + ActorShared<> parent_; + + unique_ptr unconfirmed_authorizations_; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AffectedHistory.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AffectedHistory.h new file mode 100644 index 0000000000..f303ede874 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AffectedHistory.h @@ -0,0 +1,33 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/telegram/telegram_api.h" + +#include "td/utils/common.h" + +namespace td { + +struct AffectedHistory { + int32 pts_; + int32 pts_count_; + bool is_final_; + + explicit AffectedHistory(tl_object_ptr &&affected_history) + : pts_(affected_history->pts_) + , pts_count_(affected_history->pts_count_) + , is_final_(affected_history->offset_ <= 0) { + } + + explicit AffectedHistory(tl_object_ptr &&affected_history) + : pts_(affected_history->pts_) + , pts_count_(affected_history->pts_count_) + , is_final_(affected_history->offset_ <= 0) { + } +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AffiliateType.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AffiliateType.h new file mode 100644 index 0000000000..fd4e1f68c9 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AffiliateType.h @@ -0,0 +1,43 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/telegram/DialogId.h" +#include "td/telegram/td_api.h" +#include "td/telegram/telegram_api.h" + +#include "td/utils/common.h" +#include "td/utils/Status.h" +#include "td/utils/StringBuilder.h" + +namespace td { + +class Td; + +class AffiliateType { + DialogId dialog_id_; + + explicit AffiliateType(DialogId dialog_id) : dialog_id_(dialog_id) { + } + + public: + AffiliateType() = default; + + static Result get_affiliate_type(Td *td, const td_api::object_ptr &type); + + DialogId get_dialog_id() const { + return dialog_id_; + } + + telegram_api::object_ptr get_input_peer(Td *td) const; + + td_api::object_ptr get_affiliate_type_object(Td *td) const; +}; + +StringBuilder &operator<<(StringBuilder &string_builder, const AffiliateType &affiliate_type); + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AlarmManager.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AlarmManager.h new file mode 100644 index 0000000000..7fa9b37982 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AlarmManager.h @@ -0,0 +1,38 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/actor/actor.h" +#include "td/actor/MultiTimeout.h" + +#include "td/utils/common.h" +#include "td/utils/FlatHashMap.h" +#include "td/utils/Promise.h" + +namespace td { + +class AlarmManager final : public Actor { + public: + explicit AlarmManager(ActorShared<> parent); + + void set_alarm(double seconds, Promise &&promise); + + private: + void tear_down() final; + + static void on_alarm_timeout_callback(void *alarm_manager_ptr, int64 alarm_id); + + void on_alarm_timeout(int64 alarm_id); + + ActorShared<> parent_; + + int64 alarm_id_ = 1; + FlatHashMap> pending_alarms_; + MultiTimeout alarm_timeout_{"AlarmTimeout"}; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AnimationsManager.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AnimationsManager.h new file mode 100644 index 0000000000..62847a0c6c --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AnimationsManager.h @@ -0,0 +1,166 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/telegram/Dimensions.h" +#include "td/telegram/files/FileId.h" +#include "td/telegram/files/FileSourceId.h" +#include "td/telegram/PhotoSize.h" +#include "td/telegram/SecretInputMedia.h" +#include "td/telegram/td_api.h" +#include "td/telegram/telegram_api.h" + +#include "td/actor/actor.h" + +#include "td/utils/buffer.h" +#include "td/utils/common.h" +#include "td/utils/Promise.h" +#include "td/utils/Status.h" +#include "td/utils/WaitFreeHashMap.h" + +namespace td { + +class Td; + +class AnimationsManager final : public Actor { + public: + AnimationsManager(Td *td, ActorShared<> parent); + AnimationsManager(const AnimationsManager &) = delete; + AnimationsManager &operator=(const AnimationsManager &) = delete; + AnimationsManager(AnimationsManager &&) = delete; + AnimationsManager &operator=(AnimationsManager &&) = delete; + ~AnimationsManager() final; + + int32 get_animation_duration(FileId file_id) const; + + tl_object_ptr get_animation_object(FileId file_id) const; + + void create_animation(FileId file_id, string minithumbnail, PhotoSize thumbnail, AnimationSize animated_thumbnail, + bool has_stickers, vector &&sticker_file_ids, string file_name, string mime_type, + int32 duration, Dimensions dimensions, bool replace); + + tl_object_ptr get_input_media( + FileId file_id, telegram_api::object_ptr input_file, + telegram_api::object_ptr input_thumbnail, bool has_spoiler) const; + + SecretInputMedia get_secret_input_media(FileId animation_file_id, + telegram_api::object_ptr input_file, + const string &caption, BufferSlice thumbnail, int32 layer) const; + + FileId get_animation_thumbnail_file_id(FileId file_id) const; + + FileId get_animation_animated_thumbnail_file_id(FileId file_id) const; + + void delete_animation_thumbnail(FileId file_id); + + FileId dup_animation(FileId new_id, FileId old_id); + + void merge_animations(FileId new_id, FileId old_id); + + void on_update_animation_search_emojis(); + + void on_update_animation_search_provider(); + + void on_update_saved_animations_limit(); + + void reload_saved_animations(bool force); + + void repair_saved_animations(Promise &&promise); + + void on_get_saved_animations(bool is_repair, tl_object_ptr &&saved_animations_ptr); + + void on_get_saved_animations_failed(bool is_repair, Status error); + + vector get_saved_animations(Promise &&promise); + + FileSourceId get_saved_animations_file_source_id(); + + void send_save_gif_query(FileId animation_id, bool unsave, Promise &&promise); + + void add_saved_animation(const tl_object_ptr &input_file, Promise &&promise); + + void add_saved_animation_by_id(FileId animation_id); + + void remove_saved_animation(const tl_object_ptr &input_file, Promise &&promise); + + template + void store_animation(FileId file_id, StorerT &storer) const; + + template + FileId parse_animation(ParserT &parser); + + string get_animation_search_text(FileId file_id) const; + + void get_current_state(vector> &updates) const; + + private: + class Animation { + public: + string file_name; + string mime_type; + int32 duration = 0; + Dimensions dimensions; + string minithumbnail; + PhotoSize thumbnail; + AnimationSize animated_thumbnail; + + bool has_stickers = false; + vector sticker_file_ids; + + FileId file_id; + }; + + const Animation *get_animation(FileId file_id) const; + + FileId on_get_animation(unique_ptr new_animation, bool replace); + + int64 get_saved_animations_hash(const char *source) const; + + void add_saved_animation_impl(FileId animation_id, bool add_on_server, Promise &&promise); + + void load_saved_animations(Promise &&promise); + + void on_load_saved_animations_from_database(const string &value); + + void on_load_saved_animations_finished(vector &&saved_animation_ids, bool from_database = false); + + void try_send_update_animation_search_parameters() const; + + td_api::object_ptr get_update_animation_search_parameters_object() const; + + td_api::object_ptr get_update_saved_animations_object() const; + + void send_update_saved_animations(bool from_database = false); + + void save_saved_animations_to_database(); + + void tear_down() final; + + class AnimationListLogEvent; + + Td *td_; + ActorShared<> parent_; + + WaitFreeHashMap, FileIdHash> animations_; + + int32 saved_animations_limit_ = 200; + vector saved_animation_ids_; + vector saved_animation_file_ids_; + double next_saved_animations_load_time_ = 0; + bool are_saved_animations_being_loaded_ = false; + bool are_saved_animations_loaded_ = false; + vector> load_saved_animations_queries_; + vector> repair_saved_animations_queries_; + FileSourceId saved_animations_file_source_id_; + + string animation_search_emojis_; + string animation_search_provider_; + bool is_animation_search_emojis_inited_ = false; + bool is_animation_search_provider_inited_ = false; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/Application.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/Application.h new file mode 100644 index 0000000000..fcc496a34e --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/Application.h @@ -0,0 +1,28 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/telegram/DialogId.h" +#include "td/telegram/telegram_api.h" + +#include "td/utils/common.h" +#include "td/utils/Promise.h" + +namespace td { + +struct BinlogEvent; + +class Td; + +void get_invite_text(Td *td, Promise &&promise); + +void save_app_log(Td *td, const string &type, DialogId dialog_id, tl_object_ptr &&data, + Promise &&promise); + +void on_save_app_log_binlog_event(Td *td, BinlogEvent &&event); + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AttachMenuManager.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AttachMenuManager.h new file mode 100644 index 0000000000..1ae9ee66a5 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AttachMenuManager.h @@ -0,0 +1,140 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/telegram/files/FileId.h" +#include "td/telegram/files/FileSourceId.h" +#include "td/telegram/td_api.h" +#include "td/telegram/telegram_api.h" +#include "td/telegram/UserId.h" + +#include "td/actor/actor.h" + +#include "td/utils/common.h" +#include "td/utils/FlatHashMap.h" +#include "td/utils/Promise.h" +#include "td/utils/Status.h" + +namespace td { + +class Td; + +class AttachMenuManager final : public Actor { + public: + AttachMenuManager(Td *td, ActorShared<> parent); + + void init(); + + void reload_attach_menu_bots(Promise &&promise); + + void get_attach_menu_bot(UserId user_id, Promise> &&promise); + + void reload_attach_menu_bot(UserId user_id, Promise &&promise); + + FileSourceId get_attach_menu_bot_file_source_id(UserId user_id); + + void toggle_bot_is_added_to_attach_menu(UserId user_id, bool is_added, bool allow_write_access, + Promise &&promise); + + void get_current_state(vector> &updates) const; + + static string get_attach_menu_bots_database_key(); + + private: + void start_up() final; + + void timeout_expired() final; + + void tear_down() final; + + struct AttachMenuBotColor { + int32 light_color_ = -1; + int32 dark_color_ = -1; + + template + void store(StorerT &storer) const; + + template + void parse(ParserT &parser); + }; + + friend bool operator==(const AttachMenuBotColor &lhs, const AttachMenuBotColor &rhs); + + friend bool operator!=(const AttachMenuBotColor &lhs, const AttachMenuBotColor &rhs); + + struct AttachMenuBot { + bool is_added_ = false; + UserId user_id_; + bool supports_self_dialog_ = false; + bool supports_user_dialogs_ = false; + bool supports_bot_dialogs_ = false; + bool supports_group_dialogs_ = false; + bool supports_broadcast_dialogs_ = false; + bool request_write_access_ = false; + bool show_in_attach_menu_ = false; + bool show_in_side_menu_ = false; + bool side_menu_disclaimer_needed_ = false; + string name_; + AttachMenuBotColor name_color_; + FileId default_icon_file_id_; + FileId ios_static_icon_file_id_; + FileId ios_animated_icon_file_id_; + FileId android_icon_file_id_; + FileId macos_icon_file_id_; + FileId android_side_menu_icon_file_id_; + FileId ios_side_menu_icon_file_id_; + FileId macos_side_menu_icon_file_id_; + AttachMenuBotColor icon_color_; + FileId placeholder_file_id_; + + static constexpr uint32 CACHE_VERSION = 3; + uint32 cache_version_ = 0; + + template + void store(StorerT &storer) const; + + template + void parse(ParserT &parser); + }; + + class AttachMenuBotsLogEvent; + + friend bool operator==(const AttachMenuBot &lhs, const AttachMenuBot &rhs); + + friend bool operator!=(const AttachMenuBot &lhs, const AttachMenuBot &rhs); + + bool is_active() const; + + Result get_attach_menu_bot(tl_object_ptr &&bot); + + td_api::object_ptr get_attachment_menu_bot_object(const AttachMenuBot &bot) const; + + td_api::object_ptr get_update_attachment_menu_bots_object() const; + + void remove_bot_from_attach_menu(UserId user_id); + + void send_update_attach_menu_bots() const; + + void save_attach_menu_bots(); + + void on_reload_attach_menu_bots(Result> &&result); + + void on_get_attach_menu_bot(UserId user_id, + Result> &&result, + Promise> &&promise); + + Td *td_; + ActorShared<> parent_; + + bool is_inited_ = false; + int64 hash_ = 0; + vector attach_menu_bots_; + FlatHashMap attach_menu_bot_file_source_ids_; + vector> reload_attach_menu_bots_queries_; +}; + +} // namespace td diff --git a/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AudiosManager.h b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AudiosManager.h new file mode 100644 index 0000000000..cf83089917 --- /dev/null +++ b/third-party/td/TdBinding/SharedHeaders/td/td/telegram/AudiosManager.h @@ -0,0 +1,90 @@ +// +// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2025 +// +// Distributed under the Boost Software License, Version 1.0. (See accompanying +// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +// +#pragma once + +#include "td/telegram/files/FileId.h" +#include "td/telegram/PhotoSize.h" +#include "td/telegram/SecretInputMedia.h" +#include "td/telegram/td_api.h" +#include "td/telegram/telegram_api.h" + +#include "td/utils/buffer.h" +#include "td/utils/common.h" +#include "td/utils/WaitFreeHashMap.h" + +namespace td { + +class Td; + +class AudiosManager { + public: + explicit AudiosManager(Td *td); + AudiosManager(const AudiosManager &) = delete; + AudiosManager &operator=(const AudiosManager &) = delete; + AudiosManager(AudiosManager &&) = delete; + AudiosManager &operator=(AudiosManager &&) = delete; + ~AudiosManager(); + + int32 get_audio_duration(FileId file_id) const; + + tl_object_ptr get_audio_object(FileId file_id) const; + + td_api::object_ptr get_notification_sound_object(FileId file_id) const; + + void create_audio(FileId file_id, string minithumbnail, PhotoSize thumbnail, string file_name, string mime_type, + int32 duration, string title, string performer, int32 date, bool replace); + + tl_object_ptr get_input_media( + FileId file_id, telegram_api::object_ptr input_file, + telegram_api::object_ptr input_thumbnail) const; + + SecretInputMedia get_secret_input_media(FileId audio_file_id, + telegram_api::object_ptr input_file, + const string &caption, BufferSlice thumbnail, int32 layer) const; + + FileId get_audio_thumbnail_file_id(FileId file_id) const; + + void append_audio_album_cover_file_ids(FileId file_id, vector &file_ids) const; + + void delete_audio_thumbnail(FileId file_id); + + FileId dup_audio(FileId new_id, FileId old_id); + + void merge_audios(FileId new_id, FileId old_id); + + template + void store_audio(FileId file_id, StorerT &storer) const; + + template + FileId parse_audio(ParserT &parser); + + string get_audio_search_text(FileId file_id) const; + + private: + class Audio { + public: + string file_name; + string mime_type; + int32 duration = 0; + int32 date = 0; + string title; + string performer; + string minithumbnail; + PhotoSize thumbnail; + + FileId file_id; + }; + + const Audio *get_audio(FileId file_id) const; + + FileId on_get_audio(unique_ptr