Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Tcl Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text

HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Tcl) Using Pre-defined JSON Templates

Demonstrates how to predefine a JSON template, and then use it to emit JSON with variable substitutions.

Note: This example requires Chilkat v9.5.0.67 or greater.

Chilkat Tcl Extension Downloads

Chilkat Tcl Extension Downloads

load ./chilkat.dll

#  One way to create JSON is to do it in a straightforward manner:
set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0
CkJsonObject_UpdateString $json "id" "0001"
CkJsonObject_UpdateString $json "type" "donut"
CkJsonObject_UpdateString $json "name" "Cake"
CkJsonObject_UpdateString $json "image.url" "images/0001.jpg"
CkJsonObject_UpdateInt $json "image.width" 200
CkJsonObject_UpdateInt $json "image.height" 200
CkJsonObject_UpdateString $json "thumbnail.url" "images/thumbnails/0001.jpg"
CkJsonObject_UpdateInt $json "thumbnail.width" 32
CkJsonObject_UpdateInt $json "thumbnail.height" 32
puts [CkJsonObject_emit $json]

#  The JSON created by the above code:

#  	{
#  	  "id": "0001",
#  	  "type": "donut",
#  	  "name": "Cake",
#  	  "image": {
#  	    "url": "images/0001.jpg",
#  	    "width": 200,
#  	    "height": 200
#  	  },
#  	  "thumbnail": {
#  	    "url": "images/thumbnails/0001.jpg",
#  	    "width": 32,
#  	    "height": 32
#  	  }
#  	}

#  An alternative is to predefine a template, and then use it to emit with variable substitutions.
#  For example:

set jsonTemplate [new_CkJsonObject]

CkJsonObject_UpdateString $jsonTemplate "id" "{$id}"
CkJsonObject_UpdateString $jsonTemplate "type" "donut"
CkJsonObject_UpdateString $jsonTemplate "name" "{$name}"
CkJsonObject_UpdateString $jsonTemplate "image.url" "{$imageUrl}"
#  The "i." indicates that it's an integer variable.
CkJsonObject_UpdateString $jsonTemplate "image.width" "{$i.imageWidth}"
CkJsonObject_UpdateString $jsonTemplate "image.height" "{$i.imageHeight}"
CkJsonObject_UpdateString $jsonTemplate "thumbnail.url" "{$thumbUrl}"
CkJsonObject_UpdateString $jsonTemplate "thumbnail.width" "{$i.thumbWidth}"
CkJsonObject_UpdateString $jsonTemplate "thumbnail.height" "{$i.thumbHeight}"
#  Give this template a name.
CkJsonObject_Predefine $jsonTemplate "donut"

#  --------------------------------------------------------------------------
#  OK, the template is defined.  Defining a template can be done once
#  at the start of your program, and you can discard the jsonTemplate object (it
#  doesn't need to stick around..)

#  Now we can create instances of the JSON object by name:
set jsonDonut [new_CkJsonObject]

CkJsonObject_put_EmitCompact $jsonDonut 0
CkJsonObject_LoadPredefined $jsonDonut "donut"
puts [CkJsonObject_emit $jsonDonut]

#  The output is this:

#  	{
#  	  "id": "{$id}",
#  	  "type": "donut",
#  	  "name": "{$name}",
#  	  "image": {
#  	    "url": "{$imageUrl}",
#  	    "width": "{$i.imageWidth}",
#  	    "height": "{$i.imageHeight}"
#  	  },
#  	  "thumbnail": {
#  	    "url": "{$thumbUrl}",
#  	    "width": "{$i.thumbWidth}",
#  	    "height": "{$i.thumbHeight}"
#  	  }
#  	}

#  Finally, we can substitute variables like this:
set donutValues [new_CkHashtable]

CkHashtable_AddStr $donutValues "id" "0001"
CkHashtable_AddStr $donutValues "name" "Cake"
CkHashtable_AddStr $donutValues "imageUrl" "images/0001.jpg"
CkHashtable_AddInt $donutValues "imageWidth" 200
CkHashtable_AddInt $donutValues "imageHeight" 200
CkHashtable_AddStr $donutValues "thumbUrl" "images/thumbnails/0001.jpg"
CkHashtable_AddInt $donutValues "thumbWidth" 32
CkHashtable_AddInt $donutValues "thumbHeight" 32

#  Emit with variable substitutions:
set omitEmpty 1
puts [CkJsonObject_emitWithSubs $jsonDonut $donutValues $omitEmpty]

#  Output:

#  	{
#  	  "id": "0001",
#  	  "type": "donut",
#  	  "name": "Cake",
#  	  "image": {
#  	    "url": "images/0001.jpg",
#  	    "width": 200,
#  	    "height": 200
#  	  },
#  	  "thumbnail": {
#  	    "url": "images/thumbnails/0001.jpg",
#  	    "width": 32,
#  	    "height": 32
#  	  }
#  	}

#  Change some of the values:
CkHashtable_AddStr $donutValues "id" "0002"
CkHashtable_AddStr $donutValues "imageUrl" "images/0002.jpg"
CkHashtable_AddStr $donutValues "thumbUrl" "images/thumbnails/0002.jpg"

puts [CkJsonObject_emitWithSubs $jsonDonut $donutValues $omitEmpty]

#  Output:

#  	{
#  	  "id": "0002",
#  	  "type": "donut",
#  	  "name": "Cake",
#  	  "image": {
#  	    "url": "images/0002.jpg",
#  	    "width": 200,
#  	    "height": 200
#  	  },
#  	  "thumbnail": {
#  	    "url": "images/thumbnails/0002.jpg",
#  	    "width": 32,
#  	    "height": 32
#  	  }
#  	}

delete_CkJsonObject $json
delete_CkJsonObject $jsonTemplate
delete_CkJsonObject $jsonDonut
delete_CkHashtable $donutValues

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.