FCL Reference Guide
Total Page:16
File Type:pdf, Size:1020Kb
Free Component Library (FCL): Reference guide. Reference guide for FCL units. Document version 3.2.2 May 2021 Michaël Van Canneyt Contents 0.1 Overview........................................ 88 1 Reference for unit ’ascii85’ 89 1.1 Used units........................................ 89 1.2 Overview........................................ 89 1.3 Constants, types and variables............................. 89 1.3.1 Types...................................... 89 1.4 TASCII85DecoderStream................................ 90 1.4.1 Description................................... 90 1.4.2 Method overview................................ 90 1.4.3 Property overview............................... 90 1.4.4 TASCII85DecoderStream.Create........................ 90 1.4.5 TASCII85DecoderStream.Decode....................... 91 1.4.6 TASCII85DecoderStream.Close........................ 91 1.4.7 TASCII85DecoderStream.ClosedP....................... 91 1.4.8 TASCII85DecoderStream.Destroy....................... 91 1.4.9 TASCII85DecoderStream.Read........................ 92 1.4.10 TASCII85DecoderStream.Seek........................ 92 1.4.11 TASCII85DecoderStream.BExpectBoundary................. 92 1.5 TASCII85EncoderStream................................ 92 1.5.1 Description................................... 92 1.5.2 Method overview................................ 93 1.5.3 Property overview............................... 93 1.5.4 TASCII85EncoderStream.Create........................ 93 1.5.5 TASCII85EncoderStream.Destroy....................... 93 1.5.6 TASCII85EncoderStream.Write........................ 93 1.5.7 TASCII85EncoderStream.Width........................ 94 1.5.8 TASCII85EncoderStream.Boundary...................... 94 1.6 TASCII85RingBuffer.................................. 94 1.6.1 Description................................... 94 1.6.2 Method overview................................ 94 1 CONTENTS 1.6.3 Property overview............................... 94 1.6.4 TASCII85RingBuffer.Write.......................... 95 1.6.5 TASCII85RingBuffer.Read........................... 95 1.6.6 TASCII85RingBuffer.FillCount........................ 95 1.6.7 TASCII85RingBuffer.Size........................... 95 2 Reference for unit ’AVL_Tree’ 96 2.1 Used units........................................ 96 2.2 Overview........................................ 96 2.3 Constants, types and variables............................. 96 2.3.1 Types...................................... 96 2.3.2 Variables.................................... 97 2.4 TAVLTree........................................ 97 2.4.1 Description................................... 97 2.4.2 Method overview................................ 98 2.4.3 Property overview............................... 99 2.4.4 TAVLTree.Create................................ 99 2.4.5 TAVLTree.CreateObjectCompare....................... 99 2.4.6 TAVLTree.Destroy............................... 99 2.4.7 TAVLTree.SetNodeManager.......................... 99 2.4.8 TAVLTree.NewNode.............................. 100 2.4.9 TAVLTree.DisposeNode............................ 100 2.4.10 TAVLTree.Add................................. 100 2.4.11 TAVLTree.AddAscendingSequence...................... 101 2.4.12 TAVLTree.Delete................................ 101 2.4.13 TAVLTree.Remove............................... 101 2.4.14 TAVLTree.RemovePointer........................... 102 2.4.15 TAVLTree.MoveDataLeftMost......................... 102 2.4.16 TAVLTree.MoveDataRightMost........................ 102 2.4.17 TAVLTree.Clear................................ 102 2.4.18 TAVLTree.FreeAndClear............................ 103 2.4.19 TAVLTree.FreeAndDelete........................... 103 2.4.20 TAVLTree.Equals................................ 103 2.4.21 TAVLTree.IsEqual............................... 103 2.4.22 TAVLTree.Assign................................ 104 2.4.23 TAVLTree.Compare.............................. 104 2.4.24 TAVLTree.Find................................. 104 2.4.25 TAVLTree.FindKey............................... 104 2.4.26 TAVLTree.FindNearestKey........................... 105 2.4.27 TAVLTree.FindSuccessor............................ 105 2 CONTENTS 2.4.28 TAVLTree.FindPrecessor............................ 105 2.4.29 TAVLTree.FindLowest............................. 106 2.4.30 TAVLTree.FindHighest............................. 106 2.4.31 TAVLTree.FindNearest............................. 106 2.4.32 TAVLTree.FindPointer............................. 106 2.4.33 TAVLTree.FindLeftMost............................ 107 2.4.34 TAVLTree.FindRightMost........................... 107 2.4.35 TAVLTree.FindLeftMostKey.......................... 107 2.4.36 TAVLTree.FindRightMostKey......................... 107 2.4.37 TAVLTree.FindLeftMostSameKey....................... 108 2.4.38 TAVLTree.FindRightMostSameKey...................... 108 2.4.39 TAVLTree.GetEnumerator........................... 108 2.4.40 TAVLTree.GetEnumeratorHighToLow..................... 108 2.4.41 TAVLTree.ConsistencyCheck......................... 109 2.4.42 TAVLTree.WriteReportToStream....................... 109 2.4.43 TAVLTree.NodeToReportStr.......................... 109 2.4.44 TAVLTree.ReportAsString........................... 109 2.4.45 TAVLTree.OnCompare............................. 110 2.4.46 TAVLTree.OnObjectCompare......................... 110 2.4.47 TAVLTree.NodeClass.............................. 110 2.4.48 TAVLTree.Root................................. 110 2.4.49 TAVLTree.Count................................ 111 2.5 TAVLTreeNode..................................... 111 2.5.1 Description................................... 111 2.5.2 Method overview................................ 111 2.5.3 TAVLTreeNode.Successor........................... 111 2.5.4 TAVLTreeNode.Precessor........................... 111 2.5.5 TAVLTreeNode.Clear.............................. 112 2.5.6 TAVLTreeNode.TreeDepth........................... 112 2.5.7 TAVLTreeNode.ConsistencyCheck....................... 112 2.5.8 TAVLTreeNode.GetCount........................... 112 2.6 TAVLTreeNodeEnumerator............................... 112 2.6.1 Description................................... 112 2.6.2 Method overview................................ 113 2.6.3 Property overview............................... 113 2.6.4 TAVLTreeNodeEnumerator.Create....................... 113 2.6.5 TAVLTreeNodeEnumerator.GetEnumerator.................. 113 2.6.6 TAVLTreeNodeEnumerator.MoveNext..................... 113 2.6.7 TAVLTreeNodeEnumerator.Current...................... 113 2.6.8 TAVLTreeNodeEnumerator.LowToHigh.................... 114 3 CONTENTS 2.7 TAVLTreeNodeMemManager............................. 114 2.7.1 Description................................... 114 2.7.2 Method overview................................ 114 2.7.3 Property overview............................... 114 2.7.4 TAVLTreeNodeMemManager.DisposeNode.................. 114 2.7.5 TAVLTreeNodeMemManager.NewNode.................... 115 2.7.6 TAVLTreeNodeMemManager.Clear...................... 115 2.7.7 TAVLTreeNodeMemManager.Create..................... 115 2.7.8 TAVLTreeNodeMemManager.Destroy..................... 115 2.7.9 TAVLTreeNodeMemManager.MinimumFreeNode.............. 116 2.7.10 TAVLTreeNodeMemManager.MaximumFreeNodeRatio........... 116 2.7.11 TAVLTreeNodeMemManager.Count...................... 116 2.8 TBaseAVLTreeNodeManager.............................. 116 2.8.1 Description................................... 116 2.8.2 Method overview................................ 117 2.8.3 TBaseAVLTreeNodeManager.DisposeNode.................. 117 2.8.4 TBaseAVLTreeNodeManager.NewNode.................... 117 3 Reference for unit ’base64’ 118 3.1 Used units........................................ 118 3.2 Overview........................................ 118 3.3 Constants, types and variables............................. 118 3.3.1 Types...................................... 118 3.4 Procedures and functions................................ 119 3.4.1 DecodeStringBase64.............................. 119 3.4.2 EncodeStringBase64.............................. 119 3.5 EBase64DecodingException.............................. 119 3.5.1 Description................................... 119 3.6 TBase64DecodingStream................................ 119 3.6.1 Description................................... 119 3.6.2 Method overview................................ 120 3.6.3 Property overview............................... 120 3.6.4 TBase64DecodingStream.Create........................ 120 3.6.5 TBase64DecodingStream.Reset........................ 120 3.6.6 TBase64DecodingStream.Read........................ 120 3.6.7 TBase64DecodingStream.Seek......................... 121 3.6.8 TBase64DecodingStream.EOF......................... 121 3.6.9 TBase64DecodingStream.Mode........................ 121 3.7 TBase64EncodingStream................................ 122 3.7.1 Description................................... 122 4 CONTENTS 3.7.2 Method overview................................ 122 3.7.3 TBase64EncodingStream.Destroy....................... 122 3.7.4 TBase64EncodingStream.Flush........................ 122 3.7.5 TBase64EncodingStream.Write........................ 123 3.7.6 TBase64EncodingStream.Seek......................... 123 4 Reference for unit ’BlowFish’ 124 4.1 Used units........................................ 124 4.2 Overview........................................ 124 4.3 Constants, types and variables............................. 124 4.3.1 Constants.................................... 124 4.3.2 Types.....................................